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

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

如果 function 文档位于已记录的 function 之前，则不需要使用 @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);