Use to render member signature, its description and parameters list include-doxygen-member namespace utils { namespace nested { /** * top **level** comment *of* important * * list one * * list two * * list three * * 1. number one * 2. number two * * @param first_param description of first *param* * 1. item a * 2. item b * @param second_param description of second param */ void my_func(int first_param, bool second_param) { } /** * specific description for single param version * @param first_param description of first *param* * 1. item a * 2. item b */ void my_func(int first_param) { } } } void free_func() { } :include-doxygen-member: utils::nested::my_func top level comment of important list one list two list three number one number two first_param int description of first param item a item b second_param bool description of second param top level comment of important list one list two list three number one number two :include-doxygen-member: multi_println /** * prints a value and a new line * @param v1 value to print * @param v2 value to print * @tparam T1 type of the value one to print * @tparam T2 type of the value two to print */ template<typename T1, typename T2> void multi_println(const T1& v1, const T2& v2) { std::cout << v1 << ", " << v2 << "\n"; } prints a value and a new line v1 const T1 & value to print v2 const T2 & value to print v1 const T1 & value to print v2 const T2 & value to print prints a value and a new line

Use parameter to render only member signature signatureOnly: true namespace utils { namespace second { /** * **Domain** specific context setting. Describes business setting and requirements. * * @note Do not reveal your password. * Use alternatives: * 1. option one * 2. option two * * more context */ class MyClass { public: /// bark void bark(); }; /** * **Domain** specific context setting. Describes business setting and requirements. */ class ThirdClass { public: /// bark void bark(); }; } } :include-doxygen-member: utils::second::ThirdClass::bark { signatureOnly: true } bark

namespace utils { namespace nested { void their_func(long param1, std::string param2, bool param3) { } /** * Description of *what* and *why* for their_func * * @param param1 description of param1 * @param param3 description of param3 */ void their_func(long param1, bool param3) { } void their_func(long param1) { } } } :include-doxygen-member: utils::nested::their_func { signatureOnly: true, includeAllMatches: true }

Use to select a specific overload by providing parameters string Note: Args are coma and spaces sensitive. Znai will print available args variants in case of mismatch for you to copy and paste. args :include-doxygen-member: utils::nested::their_func { args: "long, bool" } Description of what and why for their_func param1 long description of param1 param3 bool description of param3 Description of what and why for their_func

Use to render a definition of a class/struct include-doxygen-compound :include-doxygen-compound: utils::second::AnotherClass

Public Functions Static Public Functions Public Attributes Static Public Attributes Protected Functions Definitions sing bark smile number_of_sounds counter help Domain specific context setting. Describes business setting and requirements. sing out loud tone int tone at which to sing volume int volume at which to sing sing out loud bark out loud myClass const MyClass & to test reference tone int tone at which to sing volume int volume at which to sing bark out loud global smile volume int smile volume global smile current number of sounds made current number of sounds made ask for help out loud example tone int tone at which to sing volume int volume at which to sing ask for help out loud example utils::second::AnotherClass

Znai uses doxygen cross-reference to link definitions together. Class above references in its parameters. After you include definition of that class, reference above becomes a link. MyClass MyClass :include-doxygen-compound: utils::second::MyClass

Public Functions Definitions bark Domain specific context setting. Describes business setting and requirements. Do not reveal your password. Use alternatives: option one option two more context bark bark utils::second::MyClass