ark::doxygen::FunctionDefinition

Defined in header “ark/doxygen/doxygen_xml_parser.hh”.

This structure contains information about a ‘function’ or ‘method’.

std::string name
Name of the function.
std::string declaration_file
File where this was declared.
TypeString type
The type that this function returns.
std::vector< FunctionParameter > parameters
The list of parameters that this function takes as inputs.
std::string brief_description
Brief description. Each paragraph is a new line.
std::string detailed_description
Detailed description. Each paragraph is a new line.
std::vector< std::string > template_types
A list of any template parameters.
std::string code_sample
Any code examples (typically empty).