在doxygen的相对路径，允许连续集成 [英] Relative paths in doxygen to allow continous integration

问题描述

这样做的目的是创造我的整个Visual Studio的C＃自动与Doxygen的解决方案的文档。这应该发生在一个外部buildserver与詹金斯。 我的项目的结构是这样的：

The aim is to create the documentation for my whole Visual Studio C# solution automatically with Doxygen. This should happen on an external buildserver with Jenkins. The structure of my project is like that:

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

在创建的Doxyfile与Doxywizard，用于输入和输出的路径是不幸绝对 - 这意味着，它们依赖于我的显影剂机，不会在詹金斯服务器上工作了。你知道我怎么能解决呢？我怀疑这事做与Doxygen的的 FULL_PATH_NAMES 和 STRIP_FROM_PATH ，但说实话，我不吨得到这两个参数的描述。也许我是错的，这并没有什么关系的两个参数都没有。

When creating a Doxyfile with the Doxywizard, the paths for the input and output are unfortunately absolute - which means that they depend on my developer machine and won't work on the Jenkins server anymore. Do you know how I can fix that? I have the suspicion that this has something to do with Doxygen's FULL_PATH_NAMESand STRIP_FROM_PATH, but to be honest, I don't get the descriptions of those two parameters. Maybe I am wrong and this hasn't anything to do with the 2 parameters at all.

感谢您！

推荐答案

我不知道Doxygen的Windows上是否希望配置文件使用Windows路径（用反斜杠分隔符）或Unix路径（正斜杠）。无论如何，你应该确保你的路径是相对于从中运行的doxygen的目录。

I'm not sure whether doxygen on Windows expects the configuration file to use Windows paths (with the backslash separator) or Unix paths (with the forward slash). Regardless, you should make sure your paths are relative to the directory from which you run doxygen.

在你的Doxyfile，将输入列表和 OUTPUT_DIRECTORY 为相对路径。假设你从内运行的根的：

In your Doxyfile, set the INPUT list and OUTPUT_DIRECTORY to relative paths. Assuming you're running from within Root:

INPUT = ./Project1 \
        ./Project2

在一般情况下，你应该更新所有指定的路径是相对的变量（并确保你的资源被签入源代码控制）。

In general, you should update all the variables that specify paths to be relative (and make sure your resources are checked into source control).

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

In some of our projects, I've found it convenient to set the OUTPUT_DIRECTORY via an environment variable:

OUTPUT_DIRECTORY = $(DOXYGEN_OUTOUT_DIR)

在其他国家，它只是一个相对路径：

in others, its just a relative path:

OUTPUT_DIRECTORY = ./gen/docs

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

The leading ./ is not strictly necessary, but it's a readable indicator that this is a relative path.

在 FULL_PATH_NAMES 变量不会帮你，它控制的文件是如何出现在生成文件列表。

The FULL_PATH_NAMES variable will not help you, it controls how the files appear in the generated File List.

这篇关于在doxygen的相对路径，允许连续集成的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！