繁体   English   中英

通过命令行指定 Doxygen 参数

[英]Specify Doxygen parameters through command line

好吧,我正在创建一个脚本来使用 Doxygen 为我的项目自动生成文档,这看起来是一个很棒的工具。
我不清楚的是,用户是否可以通过在命令之外设置它们来直接指定参数,例如项目名称、项目描述等:

doxygen -g "parameter modification here"
doxygen Doxyfile

任何提示表示赞赏!

查看常见问题解答中问题 17 的答案:http: //www.doxygen.nl/manual/faq.html#faq_cmdline ,为方便起见在下面重复:

我可以从命令行配置 doxygen 吗?

不是通过命令行选项,但是 doxygen 可以从 stdin 读取,所以你可以通过它来传递东西。 下面是一个如何从命令行覆盖配置文件中的选项的示例(假设是 UNIX 环境):

( cat Doxyfile ; echo "PROJECT_NUMBER=1.0" ) | doxygen -

对于 Windows,以下将执行相同的操作:

( type Doxyfile & echo PROJECT_NUMBER=1.0 ) | doxygen.exe -

如果指定了多个具有相同名称的选项,那么 doxygen 将使用最后一个。 要附加到现有选项,您可以使用 += 运算符。

(这是已接受答案的替代方案 - 最有可能在上面。)

我的首选解决方案是在配置文件中使用环境变量。 让我们以“QUIET”为例:在我替换的配置文件中

QUIET                  = NO

QUIET                  = $(DOXYGEN_QUIET)

然后我按如下方式调用 Doxygen

DOXYGEN_QUIET=YES doxygen configfile

要么

env DOXYGEN_QUIET=YES doxygen configfile

如果在 (Bash) 脚本中使用。 您当然也可以导出变量 DOXYGEN_QUIET,这样您就不必在每次运行时都键入它。

PS,我有一个运行多个 Doxygen 作业的 Bash 脚本。 它使用标准 -q 选项通过设置 DOXYGEN_QUIET 安静地运行作业。 我还使用与环境变量相同的技巧设置 PROJECT_NAME。

据我所知这是不可能的:通过配置文件或 GUI 配置 doxygen 构建(这比试图记住命令行选项名称容易得多)。 在命令行键入doxygen --helpdoxygen 用法的文档建议所有命令行选项都设置要读取的配置文件(并允许用户获取布局文件等)。

从命令行修改配置选项的一种方法是使用类似(未测试)的方式将选项附加到配置文件:

echo "INPUT = some file" >> Doxyfile

这会将INPUT = some file附加到您的Doxyfile并且忽略任何早期的INPUT值。 如果你想将一个项目附加到INPUT你可以使用

echo "INPUT += some file" >> Doxyfile

注意+= 这尊重文件中前面设置的INPUT值。

您始终可以使用sed来查找和替换选项,而不是附加到配置文件。

暂无
暂无

声明:本站的技术帖子网页,遵循CC BY-SA 4.0协议,如果您需要转载,请注明本站网址或者原文地址。任何问题请咨询:yoyou2525@163.com.

 
粤ICP备18138465号  © 2020-2024 STACKOOM.COM