How to properly document a C++ function description in doxygen?

Question

I have document with doxygen as follows:

/** @fn
 * Function detailed description
 *
 * @param [in]  param1_name  description of parameter1
 * @param [in]  param2_name  description of parameter2
 * @return return_name return description
 */
uint32_t function_name(uint32_t param1_name, uint32_t param2_name);

But the detailed description isn't being rendered in the doxygen html, I have followed the guidelines from the page without any luck.

Have you tried without @fn part and with one empty line between parameters and return value? — NutCracker
– NutCracker, Commented Apr 13, 2020 at 8:01
@NutCracker the @fn is here not necessary as the documentation is just before the prototype. The empty line is not required. — albert
– albert, Commented Apr 13, 2020 at 8:23
Which version of doxygen? Do you get any documentation of the mentioned file? Otherwise try /** \file */ at the beginning of the file. — albert
– albert, Commented Apr 13, 2020 at 8:25

Jean-Marc Volle · Accepted Answer · 2020-04-13 08:07:13Z

4

You do not need to use the @fn keyword if function documentation is placed just before the documented function. Try this:

/** @brief function short description 
 *
 * function longer description if need
 * @param[in]  param1_name  description of parameter1
 * @param[in]  param2_name  description of parameter2
 * @return return_name return description
 */
uint32_t function_name(uint32_t param1_name, uint32_t param2_name);

answered Apr 13, 2020 at 8:07

Jean-Marc Volle

3,3732 gold badges19 silver badges22 bronze badges

Sign up to request clarification or add additional context in comments.

Collectives™ on Stack Overflow

How to properly document a C++ function description in doxygen?

1 Answer 1

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

Comments

Your Answer

Sign up or log in

Post as a guest

Related