Use to extract a function description Note: Plugin ignores parameters block and only includes the description text include-doxygen-doc 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-doc: utils::nested::my_func top level comment of important list one list two list three number one number two

Use param to pick an overload to use for comments extraction 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-doc: utils::nested::my_func { title: "My Params", args: "int" } specific description for single param version

To extract class top level comment, provide full class name 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-doc: utils::second::MyClass Domain specific context setting. Describes business setting and requirements. Do not reveal your password. Use alternatives: option one option two more context

Use to extract parameters description from doxygen comments Use option to make parameters smaller include-doxygen-doc-params :include-doxygen-doc-params: utils::nested::my_func { title: "My Params" } first_param int description of first param item a item b second_param bool description of second param small: true first_param int description of first param item a item b second_param bool description of second param

Use to select a specific overload by providing parameters string args :include-doxygen-doc-params: utils::nested::my_func { title: "My Params", args: "int" } first_param int description of first param item a item b

Pass parameter to plugin to extract template parameters type: "template" include-doxygen-doc-params /** * 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"; } :include-doxygen-doc-params: multi_println { title: "Template parameters", type: "template" } v1 const T1 & value to print v2 const T2 & value to print

Use as part of template parameter name to remove it from signature doc_ignore /** * prints a value and a new line * @param v1 value to print * @param v2 value to print * @param v3 value to print * @param v4 value to print * @tparam T1 type of the value one to print * @tparam T2 type of the value two to print * @tparam T3 type of the value three to print * @tparam T4 type of the value four to print */ template<typename T1, typename T2, typename T3, typename T4, typename T5_doc_ignore> void long_template_func(const T1& v1, const T2& v2, const T3& v3, const T4& v4) { } :include-doxygen-member: long_template_func {signatureOnly: true} prints a value and a new line

Return description is part of parameters list /** * sums two numbers * @param a number to add to * @param b number that is added * @return *sum* of **two** numbers */ int add(int a, int b); :include-doxygen-doc-params: math::add return sum of two numbers a int number to add to b int number that is added