如何在Doxygen配置中使用相对路径名称

Question

我的/ utils目录中有doxygen，而我的源位于根目录（/code_with_doxygen）的另一个目录中，我怎么能为它创建一个相对路径名，因为它位于一个将在的存储库中其他电脑的不同地方。我无法记录整个根目录，因为我也不想构建目录/code_without_doxygen。

项目树如下所示：

root
    utils
    code
        code_with_doxygen
        code_without_doxygen
    documentation

现在我有设置，但这似乎不起作用：

FULL_PATH_NAMES        = YES
STRIP_FROM_PATH        = ../

我似乎无法弄明白：Relative files paths in doxygen-generated documentation

Answer 1

相对路径取决于您执行doxygen目录的目录。例如，如果您有以下项目树：

+ project_root
     + documentation
         + config
             - doxyfile
         + pictures
         + output
         - run_doxygen.bat
     + code
         + code_with_doxygen
         + code_without_doxygen

在这种情况下，所有相对路径都将它们置于“文档”文件夹中，因为您正在从此文件夹运行脚本“run_doxygen.bat”。因此，您可以将“doxyfile”中的INPUT标记设置为

INPUT = ./../code

和doxyfile中的OUTPUT_DIRECTORY标记为

OUTPUT_DIRECTORY = ./output

误导性的是，即使doxyfile位于子文件夹“config”中，路径也不是相对于doxyfile的位置，因为路径是相对于调用doxygen的位置。在这种情况下，它是文件夹“documentation”，因为这是调用doxygen的脚本的位置。

Answer 2

Doxygen允许将文件包含到doxyfile中。在实际调用doxygen之前，您可以使用脚本生成文件。此文件的内容必须如下所示：

INPUT += path1
INPUT += path2
...

您似乎要运行Linux，我不知道正确的bash命令。

该文件必须集成到您的doxyfile中：

INPUT = (project path)
@INCLUDE = generated filename

这会导致使用生成文件内容的doxygen。

Answer 3

@gmug是对的。不要忘记在代码中添加注释块specified by doxygen对于python，我需要在文件的开头添加："""@package docstring"""。

Answer 4

通过将 doxygen.cfg 设置为一个字符串或一组字符串，我已经能够在我的 INPUT 文件中使用相对路径。例如：

INPUT                  = "." "src"

会告诉 doxygen 查看当前目录及其子目录 $HERE/src。