c - doxygen 忽略文件的特殊命令

Question

我正在将代码添加到使用 Doxygen 记录的大型库中。我希望某些文件不包含在 Doxygen 文档中。

doxyfile 包含许多控件来包含和排除特定文件，但由于很多人都为这个库做出了贡献，所以我宁愿避免修改 doxyfile。

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

Answer 1

您不能通过特殊命令忽略文件，但您可以通过添加应排除到 EXCLUDE 的文件的静态或相对路径，从 Doxygen 配置文件(通常称为 Doxyfile)的文档中排除文件标签，例如:

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

这样您还可以从文档中排除整个目录:

EXCLUDE =  ./../lib

您还可以使用 EXCLUDE_PATTERNS 标记并使用通配符模式，例如:

EXCLUDE_PATTERNS = */test/*

希望这有帮助。