.net - 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

一般来说，您应该将指定路径的所有变量更新为相对路径(并确保您的资源已 checkin 源代码管理)。

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

OUTPUT_DIRECTORY = $(DOXYGEN_OUTOUT_DIR)

在其他情况下，它只是一个相对路径:

OUTPUT_DIRECTORY = ./gen/docs

前导的 ./ 不是绝对必要的，但它是一个可读的指示器，表明这是一个相对路径。

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