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

问题描述 投票:0回答:1

我有含氧的文件如下:

/** @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中呈现,我遵循了页面上的指南,没有任何运气。

html c++ generator documentation doxygen
1个回答
1
投票
如果将功能文档放在已记录功能的前面,则无需使用@fn关键字。试试这个:
© www.soinside.com 2019 - 2024. All rights reserved.