doxygen特殊命令忽略文件

Question

我正在向Doxygen记录的大型库中添加代码。我希望有些文件不包含在Doxygen文档中。

doxyfile包含许多控件来包含和排除特定文件，但由于许多人参与了这个库，我宁愿避免修改doxyfile。

我是否可以将任何特殊命令放入文件本身，指示Doxygen忽略整个文件？

Answer 1

How can I make doxygen ignore some code fragment?显示了如何做到这一点。您可以将\ cond放在开头，将\ end放在最后。另请参阅How to comment out comment in Doxygen documentation

请注意，虽然仍会包含该文件，但该文件的内容将被忽略。

  

如何让doxygen忽略一些代码片段？

     

新的最简单的方法是使用\ cond添加一个注释块   命令在开头和一个注释块，带有\ endcond命令   应该忽略的代码片段的结尾。这应该是   当然在同一个文件中。

     

但你也可以使用Doxygen的预处理器：如果你把

#ifndef DOXYGEN_SHOULD_SKIP_THIS

 /* code that must be skipped by Doxygen */

#endif /* DOXYGEN_SHOULD_SKIP_THIS */

     

应隐藏和放置的块周围：

  PREDEFINED = DOXYGEN_SHOULD_SKIP_THIS

     在配置文件中

然后Doxygen将跳过所有块   只要ENABLE_PREPROCESSING设置为YES。

Answer 2

您不能通过特殊命令忽略文件，但是您可以通过添加文件的静态或相对路径来排除Doxygen配置文件（通常称为Doxyfile）中的文档中的文件，该文件将被删除到{ {1}}标记，例如：

EXCLUDE

这样您也可以从文档中排除整个目录：

EXCLUDE =  ./../lib/stdio.h

您还可以使用EXCLUDE = ./../lib 标记并使用通配符模式，例如：

EXCLUDE_PATTERNS

希望这有帮助。

Answer 3

BigBobby：“由于很多人都参与了这个库，我宁愿避免修改doxyfile。”

考虑在同一个项目中可以有多个doxyfiles。您可以复制已有的，添加所需内容，并使用其他名称保存（例如doxyfile_BigBobby）。

特别是，我通常在项目中放置两个doxyfiles，一个用于最终用户文档（仅包含接口），另一个用于开发人员。