Doxygen 合并氧气模块

Doxygen 合并氧气模块,doxygen,Doxygen,我有大量运行doxygen的代码。为了提高性能,我尝试将其分解为多个模块,并将结果合并到一组文档中。我原以为标签文件会起作用,但要么我配置错了,要么我误解了它的工作原理 目录如下: root + |-src+ | |-a | |-doc+ |-a.dox |-main.dox |-main.md |-output+ |-a+

我有大量运行doxygen的代码。为了提高性能,我尝试将其分解为多个模块,并将结果合并到一组文档中。我原以为标签文件会起作用,但要么我配置错了,要么我误解了它的工作原理

目录如下:

root +
     |-src+
     |    |-a
     |
     |-doc+
          |-a.dox
          |-main.dox
          |-main.md
          |-output+
                  |-a+
                  |  |-html
                  |-main+
                        |-html
除了“a”之外,还有其他对等目录,但我从一个开始

a、 dox生成输出并将标记文件放入root/doc/output

OUTPUT_DIRECTORY=output/a
GENERATE_TAGFILE = output/a/a.tag
INPUT=../src/a
dox只输入带有mainpage标记并引用其他项目标记文件的标记文件

OUTPUT_DIRECTORY=output/main
INPUT = main.md
TAGFILES=output/a/a.tag=output/a/html
  • 这是否应该合并或链接main下的所有文档,以便我可以浏览“a”全局文件、模块、页面等?或者,如果我从“main”内部显式交叉引用“a”中的文档实体,这是否只会生成指向“a”的链接
  • 如果这样做可行的话,有没有关于我的语法哪里不正确的想法?我尝试了各种方法来定义标记文件,输出目录是否相对于main.dox文件?到a.tag文件?或者到a/html目录
  • 如果标记文件不能以这种方式工作,是否有其他方法将doxygen目录集合并到一个目录中

  • 谢谢。

    我建议您阅读本主题,了解我建议如何使用标记文件以及应适用的条件:

    回答第一个问题:doxygen通常不会将各种索引文件合并在一起(这样就不会获得性能)。尽管对于零件,您仍然可以通过将
    ALLEXTERNALS
    设置为
    YES
    来获取索引中的外部成员

    Doxygen将(自动)链接通过标记文件导入的其他源的符号。因此,一般来说,您应该将代码划分为或多或少的自包含模块/组件/库,如果一个模块依赖于另一个模块,则导入其标记文件,以便doxygen可以链接到其他文档集。如果运行两次doxygen(一次用于标记文件,一次用于文档),也可以解析循环依赖项(如果有的话)


    在我的例子中,我创建了一个自定义索引页面,其中包含指向所有模块的链接,并在每个生成页面的菜单中创建了一个自定义条目,该页面链接回该索引(请参阅)如何将用户定义的条目添加到导航菜单/目录树。

    太好了,这非常有帮助。谢谢