doxygen中的相对路径允许持续集成

Question

目的是使用Doxygen自动为我的整个Visual Studio C＃解决方案创建文档。这应该发生在使用Jenkins的外部构建服务器上。 我项目的结构是这样的：

Root
    Tools
        doxygen-1.8.0
            doxygen.exe
    Project1
        bin
        ...
    Project2
        bin
        ...
    ...

使用Doxywizard创建Doxyfile时，输入和输出的路径不幸是绝对的 - 这意味着它们依赖于我的开发人员计算机而不再在Jenkins服务器上运行。你知道我怎么解决这个问题吗？我怀疑这与Doxygen的FULL_PATH_NAMES和STRIP_FROM_PATH有关，但说实话，我没有得到这两个参数的描述。也许我错了，这与2个参数根本没有关系。

谢谢！

Answer 1

我不确定Windows上的doxygen是否要求配置文件使用Windows路径（使用反斜杠分隔符）或Unix路径（使用正斜杠）。无论如何，您应该确保您的路径相对于运行doxygen的目录。

在Doxyfile中，将INPUT列表和OUTPUT_DIRECTORY设置为相对路径。假设你是从 Root 中运行的：

INPUT = ./Project1 \
        ./Project2

通常，您应该更新指定路径为相对的所有变量（并确保将资源检入源代码管理中）。

在我们的一些项目中，我发现通过环境变量设置OUTPUT_DIRECTORY很方便：

OUTPUT_DIRECTORY = $(DOXYGEN_OUTOUT_DIR)

在其他人看来，它只是一条相对路径：

OUTPUT_DIRECTORY = ./gen/docs

前导./并非绝对必要，但它是一个可读的指标，这是一个相对路径。

FULL_PATH_NAMES变量对您没有帮助，它控制文件在生成的文件列表中的显示方式。