问显示未记录的函数参数
EN

Stack Overflow用户

提问于 2012-05-04 17:21:16

回答 1查看 2.7K关注 0票数 2

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

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

方法描述将显示注释和参数p1，但不显示p2。

如何配置doxygen以列出方法描述中的所有参数，即使没有明确记录？

回答已采纳

发布于 2012-05-05 21:05:08

这是不可能的。

但是，about可以警告您参数文档不完整、错误或丢失。

相关设置为：

WARNINGS          = YES
WARN_IF_DOC_ERROR = YES
WARN_NO_PARAMDOC  = YES

票数 3

页面原文内容由Stack Overflow提供。腾讯云小微IT领域专用引擎提供翻译支持

原文链接：

https://stackoverflow.com/questions/10446102

复制

相似问题

问显示未记录的函数参数EN