如何设置相对于 Doxyfile 的 INPUT?
How to set INPUT relative to Doxyfile?
我的项目有一个 git 存储库,我想在存储库中添加一个 Doxyfile
,这样任何从事该项目的人都可以在他们的计算机上创建一个目录,并且只需运行 doxygen /path/to/the/repo/Doxyfile
从那里用项目的文档填充它。
我查看 https://www.doxygen.nl/manual/config.html 有一段时间了,但我就是找不到如何填写 INPUT
字段来告诉 doxygen 文件在哪里。
- 我不能使用绝对路径,因为我不知道人们会在他们机器上的什么地方克隆 repo
- 我不能使用相对路径,因为它们是相对于命令所在的位置 运行 而且我不知道人们想把他们的文档放在哪里
如何表达相对于 Doxyfile
的路径(或者可能是相对于 repo 的位置,因为这是次要的)?
Doxygen 可以在配置文件中使用环境变量,您可以在 a.o 中使用这些。 INPUT
的可能性。
这个环境变量可以通过 en 环境变量或使用例如CMake 你可以在生成阶段设置它。
另一种方法是,对于 CMake,在默认配置文件中使用 @...@
等占位符,并在 CMake 生成阶段将这些占位符替换为 CMake 生成的路径。
如果我的问题没有内置的解决方案,到目前为止我已经想出了这个。
在Doxyfile
中:
INPUT = $(DOXYFILE_DIR)/relative/path
在它旁边的 generate_doxygen.sh
文件中:
#!/bin/bash
DOXYFILE_DIR=`dirname [=11=]`
export DOXYFILE_DIR
doxygen $DOXYFILE_DIR/Doxyfile
(但我假设有一种内置的方法可以在没有额外文件的情况下完成它,我只是错过了它,因为它是一个如此基本的功能,而这是我第一次创建 Doxyfile
...)
我的项目有一个 git 存储库,我想在存储库中添加一个 Doxyfile
,这样任何从事该项目的人都可以在他们的计算机上创建一个目录,并且只需运行 doxygen /path/to/the/repo/Doxyfile
从那里用项目的文档填充它。
我查看 https://www.doxygen.nl/manual/config.html 有一段时间了,但我就是找不到如何填写 INPUT
字段来告诉 doxygen 文件在哪里。
- 我不能使用绝对路径,因为我不知道人们会在他们机器上的什么地方克隆 repo
- 我不能使用相对路径,因为它们是相对于命令所在的位置 运行 而且我不知道人们想把他们的文档放在哪里
如何表达相对于 Doxyfile
的路径(或者可能是相对于 repo 的位置,因为这是次要的)?
Doxygen 可以在配置文件中使用环境变量,您可以在 a.o 中使用这些。 INPUT
的可能性。
这个环境变量可以通过 en 环境变量或使用例如CMake 你可以在生成阶段设置它。
另一种方法是,对于 CMake,在默认配置文件中使用 @...@
等占位符,并在 CMake 生成阶段将这些占位符替换为 CMake 生成的路径。
如果我的问题没有内置的解决方案,到目前为止我已经想出了这个。
在Doxyfile
中:
INPUT = $(DOXYFILE_DIR)/relative/path
在它旁边的 generate_doxygen.sh
文件中:
#!/bin/bash
DOXYFILE_DIR=`dirname [=11=]`
export DOXYFILE_DIR
doxygen $DOXYFILE_DIR/Doxyfile
(但我假设有一种内置的方法可以在没有额外文件的情况下完成它,我只是错过了它,因为它是一个如此基本的功能,而这是我第一次创建 Doxyfile
...)