如何在 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);