如何在 doxygen 中正确记录 C++ 函数描述？

Question

我有 doxygen 的文档如下：/** @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);但详细的描述没有在 doxygen html 中呈现，我遵循了页面上的指导方针，但没有任何运气。

Answer 1

如果函数文档位于已记录函数之前，则无需使用 @fn 关键字。尝试这个：

/** @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);