Group: demo¶
This is a demo library to showcase documentation features.
A¶
functionns::abs(double) Computes the absolute value of a floating-point number.functionns::abs(int) Computes the absolute value of an integer.conceptns::Addable Concept that checks if a type supports addition.structns::Win32Structure::(Anonymous union at library.hpp:340:9)::(Anonymous struct at library.hpp:342:13)unionns::Win32Structure::(Anonymous union at library.hpp:340:9)functionns::another_function(int)functionns::filter<T>::apply(T *, size_t) Applies the filter to a data array.classns::array<N> First paragraph will automatically be the brief description.
B¶
enum constantns::Color::Blue Blue color
C¶
variablens::Data::c Character arrayenumns::Color Enumeration of colors.variablens::Win32Structure::(Anonymous union at library.hpp:340:9)::combinedstructns::ConflictingNamestructns::conflictingName @unknowntag This tag is not recognized and should be handled gracefullyclassns::C<T> A wrapper that forwards any argument into its stored value.functionns::C<T>::C<T>(U &&)
D¶
variablens::Data::d Double dataunionns::Data A union to hold different types of data.variablens::array<N>::datastructns::Demo Simple struct
E¶
enum constantns::(Unnamed enum at library.hpp:384:5)::ERR_ACCESS Permission / access deniedenum constantns::(Unnamed enum at library.hpp:384:5)::ERR_BUSY Resource is busyenum constantns::(Unnamed enum at library.hpp:384:5)::ERR_GENERIC Generic / unspecified errorenum constantns::(Unnamed enum at library.hpp:384:5)::ERR_INVALID Invalid argument or stateenum constantns::(Unnamed enum at library.hpp:384:5)::ERR_NOT_FOUND Resource not foundenum constantns::(Unnamed enum at library.hpp:384:5)::ERR_TIMEOUT Operation timed out
F¶
variablens::Data::f Float datafunctionns::factorial(int) Returns the factorial of a number.variablens::Win32Structure::(Anonymous union at library.hpp:340:9)::(Anonymous struct at library.hpp:342:13)::field1variablens::Win32Structure::(Anonymous union at library.hpp:340:9)::(Anonymous struct at library.hpp:342:13)::field2classns::filter<T> A generic filter interface.destructorns::filter<T>::~filter<T>() Virtual destructor.functionns::fn1(std::byte, Color)functionns::free_function(int) A free function in the ns namespace.
G¶
functionglobal_function() A global function that is not part of any namespace.enum constantns::Color::Green Green color
I¶
variablens::Data::i Integer datafunctionns::inl::inline_function() Inline namespace function
L¶
macroLIBRARY_VERSION
M¶
variablens::max_size Maximum size constantfunctionns::multiply_matrix(T *, const T *, size_t, size_t) Multiplies two matrices.
P¶
typedefns::Pair Template alias for a pair of typesvariablens::pi Templated inline variablededuction guidens::Point Deduction guide for Pointclassns::Point<T> A 3D point structure.
R¶
enum constantns::Color::Red Red color
S¶
typedefns::size_t Type alias for size_tfunctionns::inner::some_function() A function in the inner namespaceenum constantns::(Unnamed enum at library.hpp:384:5)::SUCCESS Operation completed successfullyvariablens::Demo::symbol A character symbol
T¶
functionns::to_name(Color) Converts aColorenum to its string representation.structns::Tpl<1>structns::Tpl<2> SeeTpl<1>functionns::Tpl<1>::tpl_foo()functionns::Tpl<2>::tpl_foo()classns::Tpl<N>
U¶
enumns::(Unnamed enum at library.hpp:384:5) Platform-independent error codes
V¶
variablens::Demo::value An integer valuevariablens::C<T>::value
W¶
structns::Win32Structure A structure demonstrating anonymous unions and structs.
X¶
variablens::Point<T>::x
Y¶
variablens::Point<T>::y
Z¶
variablens::Point<T>::z