禁止氧气警告 [英] Suppressing Doxygen warnings

问题描述

是否有一种方法可以抑制Doxygen对特定文件发出未记录的警告？我的项目有几个自动生成的代码标头，导致其引发成百上千的错误，使筛选困难。

Is there a way to suppress Doxygen from giving "not documented" warnings on particular files? My project has several automatically generated code headers that cause it to throw hundreds or thousands of errors that make it difficult to sift through.

推荐答案

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

You could use suppression tags in the generated files:

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

您不需要在其中使用 Doxygen_Suppress，但为清晰起见，我喜欢它。

You don't need the "Doxygen_Suppress" in there, but I like it for clarity.

doxygen中有更多选项常见问题解答

编辑：
好​​吧，我应该做尽职调查，我的回答是：适合您的情况。我相信您需要完全排除文件。将此添加到您的doxygen文件中：

Ok, I should have done my due diligence, I have an answer that is more appropriate to your situation. I believe you need to exclude the files entirely. Add this to your doxygen file:

# 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

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

The irony is I have had this problem and solved it, then forgot all about it... Brain must be full again.

我从 doxygen配置页面，但是如果您像我一样懒，只需使用gui工具（doxywizard）并选择所有想要的东西，并为您保存doxyfile。

I pulled this information from the doxygen Configuration page, but if you are lazy like me, just use the gui tool (doxywizard) and go through and select all the things you want and have it save the doxyfile for you.

这篇关于禁止氧气警告的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！