doxygen函数参数文档(//!<vs @param)

Question

如果我在函数参数的"成员之后"文档中使用,例如,//!<在每个参数之后使用,而不是在标题中使用@param,则"Parameters"部分始终位于生成的输出文件中的"Return"之后.

是否可以定义顺序,以便"返回"之前放置"参数"？

/**
 *****************************************************************************************
 *  @brief      Test API
 *
 *  @usage      This API can be called at any time
 *
 *  @return     0 if successful; or 1 if failed
 ****************************************************************************************/

int TestAPI(
    int argument1,       //!< first argument
    int argument2        //!< second argument
    );

Answer 1

我刚用Doxygen 1.7.5.1尝试了你的代码,并确认使用你的代码,输出中的参数列表出现在Return的描述之后.

这是一个耻辱,因为//!<样式比必须重新声明所有参数的名称要好得多@param:

/**
 *****************************************************************************************
 *  @brief      Test API
 *
 *  @usage      This API can be called at any time
 * 
 *  @param      argument1 first argument
 *  @param      argument2 second argument
 *
 *  @return     0 if successful; or 1 if failed
 ****************************************************************************************/

int TestAPI2(
    int argument1,
    int argument2
    );

我查看了Doxygen Bugzilla错误数据库,看看它是否是一个相对较新的错误(那时你可以尝试恢复到旧的安装).

我相信你已经找到Doxygen Bug 316311:'使用内联注释返回文档后的参数文档',这是在2005年9月报告的,并且尚未修复.

所以,遗憾的是,我担心您的问题的答案是否可以定义顺序,以便"返回"之前放置"参数"？几乎可以肯定是

编辑

我刚给Doxygen Bug 316311添加了一个注释,要求将其更改为Status = CONFIRMED.