1 UCPP-Doc Example#
Any included entity can be referenced, like this example::print
Method ref to class member: x.method().method()
1.1 Example code-blocks#
Extracted from second_example.hpp
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
Typedef-Struct
-
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
Semi-Regular
Requirements
sizeof(T) < 8
-
int f1() noexcept#
[src] -
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,2]
Doc-String about f1 overload-set
with multiple
lines
Comment about the float-overload, specifically.
Additional text specific to string overload.
Which can consist of multiple lines…
and also
other
lists
two parameters
Multi-Part std-reference: std::partial_ordering::unordered
-
void f3(int)#
[src] -
void f3(float)#
[src] -
Overload with single comment
And some specific part on the first
-
template<typename ...Ts>
auto print(Ts&&... ts)#
[src] -
some std::printf()-like template
- Template Parameters:
Ts – template parameter
- Parameters:
ts – value parameter
- Returns:
return value
TODO
something that still needs doing
another normal paragraph
with a large line break
indentation test
References to external projects: glfwInit(), std::string.
Inline non-C++ code
#~~>x
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_other_type#
[src] -
Attributes
POD
Regular
public:
-
friend bool operator==(const My_other_type& lhs, const My_other_type& rhs)#
[src] -
friend bool operator==(const My_other_type& lhs, int rhs)#
[src] -
Attributes
Hidden-Friend
hidden friend (should be included in My_other_type)
hidden friend (should be included in My_other_type)
-
class My_type#
[src] -
Attributes
Abstract
Copyable
Polymorphic
a class
method ref: x.method()
public:
-
friend bool operator==(const My_type& lhs, const My_type& rhs)#
[src] -
Attributes
Hidden-Friend
hidden friend (should be included in My_type)
protected:
-
template<typename T>
class Class_template#
[src] -
Attributes
Semi-Regular
Standard-Layout
public:
-
template<typename T>