3

目的是使用 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 个参数无关。

谢谢！

4

1 回答 1

4

我不确定 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变量不会帮助您，它控制文件在生成的文件列表中的显示方式。

于 2012-04-30T06:01:22.207 回答