doxygen函数参数文档（//！＆lt; vs @param）

Question

如果我在函数参数的“成员之后”文档中使用，例如，在每个参数后使用//!<，而不是在标题中使用@param，则“参数”部分始终放在“返回”之后生成的输出文件。

是否可以定义顺序，以便在“返回”之前放置“参数”？

/**
 *****************************************************************************************
 *  @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 bug database，看看它是否是一个相对较新的错误（因为那时你可以尝试恢复旧的安装）。

我相信您在2005年9月报告的“使用内联注释返回文档后找到了Doxygen Bug 316311：'参数文档”，并且尚未修复。

所以，遗憾的是，我害怕你问题的答案是否可以定义顺序，以便“参数”放在“返回”之前？几乎肯定是否。

修改

我刚刚在Doxygen Bug 316311添加了一条注释，要求将其更改为Status = CONFIRMED。