如何摆脱奇怪的doxygen警告

时间:2013-11-07 14:56:05

标签: doxygen

当运行 doxygen 超过一个包含许多文件的特定的大型C语言项目时(我想完全记录完毕),然后我总是在输出的底部找到这个警告:

<@1>:1: warning: parameters of member @1 are not (all) documented

如何找到并删除此警告的触发器?

请注意,有问题的项目对于二分法或其他基于试验和错误的搜索方法来说太大(问题不够重要)。

1 个答案:

答案 0 :(得分:0)

意识到这是一个老问题,但我自己遇到了这种行为,并没有在网上找到解决方案。

通过运行Doxygen并查看输出中出现错误消息的位置找到违规文件(确保您没有抑制stdout,或者您只是在没有上下文的情况下得到错误)。

在我的情况下,错误出现在“为组[名称]生成依赖关系图”行之后。通过查看相关文件,我找到了一个未记录的,未命名的枚举。 enum的成员仍然记录在案。 e.g。

enum
{
    X = 1, /**< Documented. */
    ...
}

我猜这是在枚举上缺少名字,这会引起Doxygen并导致无益的消息。添加名称会导致生成更多有用的错误消息。记录枚举(带或不带名称)可以删除错误。