仅对选定的文件/模块运行Doxygen?

时间:2012-02-28 14:39:23

标签: doxygen

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

因为我正在学习一点 - 我喜欢迭代编辑和生成文档,因为doc生成很慢 - 3-5分钟。这变得无法使用。

我通过删除源代码树中的大多数文件进行管理,因此doxy只发现了我正在编辑的文件,但这确实是一个非常糟糕的解决方案,而不是我经常要做的事情。

有没有办法(例如命令行arg或env变量) - 限制用于生成文档的文件/模块 - 所以重建文档可以更快地完成?

1 个答案:

答案 0 :(得分:18)

是的,您可以从命令行或通过环境变量自定义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