doxygen - 仅在选择的文件/模块上运行 Doxygen？

Question

最近我开始在一个已经有很多 doxygen 评论的现有项目中编写一些 doxygen 文档。

因为我正在学习一点 - 我喜欢迭代编辑和生成文档，因为文档生成非常慢 - 3-5 分钟。这变得不可行。

我通过删除源树中的大部分文件来管理，所以 doxy 只找到了我正在编辑的文件，但这确实是一个可怕的解决方案，而不是我想要经常做的事情。

有没有办法(例如命令行参数或环境变量) - 限制哪些文件/模块用于生成文档 - 所以重建文档可以更快地完成？

Answer 1

是的，您可以从命令行或通过环境变量自定义 Doxygen 的行为。例如，如果您只想包含一个文件 (include/somefile.h)，您可以执行 Doxygen，如下所示:

( cat Doxyfile ; echo "INPUT=include/somefile.h" ) | doxygen -

见 Doxygen FAQ的“我可以从命令行配置 doxygen 吗？”有关从命令行自定义行为的更多详细信息。

或者，如果您想使用环境变量，您可以在配置文件中指定如下内容:

INPUT = $(FILE)

Doxygen 在其配置文件上执行环境变量替换，允许您指定应该对哪些文件进行操作:

export FILE=include/somefile.h
doxygen Doxyfile

见 Doxygen Configuration有关在配置文件中使用环境变量的详细信息。