1 UCPP-Doc Example¶
Any included entity can be referenced, like this example::print
1.1 Example code-blocks¶
Extracted from second_example.hpp
1// Let:
2example::My_type & x = ...;
3
4example::my_typedef rt = x.method<43>();
5return rt;
1.2 Complete files:¶
#include <example.hpp>
-
int MY_global_func(const char* xy)¶
[src] -
Attributes
C-Linkage
DLL-Exported
brief description
another paragraph with multiple lines
- Parameters
xy – The documentation for ARG xy
- Precondition
Some precondition
-
using MY_opaque_handle = struct MY_opaque_handle¶
[src] -
Attributes
Opaque-Handle
-
void MY_global_func_2(MY_c_style_struct*)¶
[src] -
Attributes
C-Linkage
- namespace example
-
-
template<typename T>
void concept_f(T)¶
[src] -
template<typename T>
void concept_f(T)¶
requires is_meowable<T>
[src] -
template<Meowable T>
void concept_f(T)¶
requires (sizeof(T) < 16)
[src] -
-
template<typename T, typename U>
struct My_template¶
[src] -
Attributes
Hashable
POD
Requirements
sizeof(T) < 8
-
int f1(float x) noexcept¶
[src] -
int f1(const std::string& x) noexcept(sizeof(int) > 2)¶
[src] -
int f1(float x, int y)¶
[src] -
Attributes
Constexpr [1]
Doc-String about f1 overload-set
with multiple
lines
Comment about the float-overload, specifically.
two parameters
-
template<typename ...Ts>
auto print(Ts&&... ts)¶
[src] -
some template
- Template Parameters
Ts – template parameter
- Parameters
ts – value parameter
- Returns
return value
TODO
something that still needs doing
another normal paragraph
indentation test
A reference to an external project glfwInit()
Danger
Danger Danger Danger
This line should also be part of the previous command!
Danger
And this is a new one
See also
-
class My_type¶
[src] -
Attributes
Abstract
Polymorphic
a class
public:
-
template<int N>
my_typedef method()¶
[src] -
Requirements
N > 42
protected:
-
template<typename T>
class Class_template¶
[src] -
Attributes
Copy-Constructable
Standard-Layout
public:
-
template<typename T>