【问题标题】:Run Doxygen only on select files / modules?仅在选择的文件/模块上运行 Doxygen?
【发布时间】:2012-03-18 00:58:59
【问题描述】:

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

由于我正在学习一点 - 我喜欢迭代编辑和生成文档,因为文档生成速度很慢 - 3-5 分钟。这变得不可行。

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

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

【问题讨论】:

标签: doxygen


【解决方案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

【讨论】:

    猜你喜欢
    • 2019-05-14
    • 1970-01-01
    • 1970-01-01
    • 2018-10-16
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    相关资源
    最近更新 更多