显示未记录的函数参数

时间:2012-05-04 09:21:16

标签: doxygen

我正在使用doxygen来生成C ++代码的HTML文档。不幸的是,doxygen在方法描述中没有显示未记录的方法参数。例如,使用以下

/**
 * Some method
 * @param p1 Some param
 */
void method(const std::string& p1, const std::string& p2);

方法说明会显示评论和参数p1,但不会显示p2

如果没有明确记录,我如何配置doxygen列出方法描述中的所有参数?

1 个答案:

答案 0 :(得分:3)

这是不可能的。

Doxygen可以警告您不完整,错误或缺少参数文档。

相关设置为:

WARNINGS          = YES
WARN_IF_DOC_ERROR = YES
WARN_NO_PARAMDOC  = YES