抑制Doxygen警告

Question

有没有办法抑制Doxygen对特定文件提供“未记录”的警告？我的项目有几个自动生成的代码头，导致它抛出数百或数千个错误，使得难以筛选。

Answer 1

有一个配置选项，如documentation

中所述

  

WARN_IF_UNDOCUMENTED

     

如果WARN_IF_UNDOCUMENTED设置为YES，那么   doxygen将为无证件的成员生成警告。如果   EXTRACT_ALL设置为YES，然后此标志将自动生效   禁用。

Answer 2

您可以在生成的文件中使用抑制标记：

//! @cond Doxygen_Suppress
code
//! @endcond

你不需要那里的“Doxygen_Suppress”，但为了清楚起见我喜欢它。

doxygen FAQ

中有更多选项

修改 好的，我应该尽职尽责，我有一个更适合你情况的答案。我相信你需要完全排除这些文件。将其添加到您的doxygen文件中：

# The EXCLUDE tag can be used to specify files and/or directories that should 
# excluded from the INPUT source files. This way you can easily exclude a 
# subdirectory from a directory tree whose root is specified with the INPUT tag.

EXCLUDE                = abc.cpp \
                         abc.h

具有讽刺意味的是，我遇到了这个问题并解决了它，然后忘记了所有这些......脑子必须再次充满。

我从doxygen Configuration page中提取了这些信息，但是如果你像我一样懒，只需使用gui工具（doxywizard）然后选择你想要的所有内容并让它为你保存doxyfile。

Answer 3

在我自动生成的标题中，我只是将doxygen文档添加到自动生成例程中。

这意味着没有任何内容没有记录。

Answer 4

如果有人使用 Eclipse ，我绝对建议用文本编辑器打开你的文件（* .doxyfile）（注意eclipse默认使用“Doxyfile Editor”打开它）。

所以：

• 右键单击您的doxyfile并选择“open-with” - ＆gt;“text editor”
• 搜索 WARN_IF_UNDOCUMENTED （默认设置为“是”）
• 更改“否”。

添加标签

//! @cond Doxygen_Suppress
code
//! @endcond

如果你有很多课，那应该很无聊。

其他配置选项的文档可用 here 。