如果您的项目依赖于外部库或工具,那么在每次运行 Doxygen 时不包含这些外部源有很多原因。
如果外部包及其文档的版权属于他人,最好(甚至必须)引用它,而不是在您项目的文档中包含其副本。当作者禁止再分发时,这是必要的。如果作者要求满足某些许可条件作为再分发的前提条件,而您不想受这些条件的约束,那么引用他们文档的副本优于包含副本。
如果以上任何情况适用,您可以使用 Doxygen 的标签文件(tag file)机制。标签文件本质上是外部源文件中实体的紧凑表示。Doxygen 可以生成和读取标签文件。
要为您的项目生成标签文件,只需在配置文件中的 GENERATE_TAGFILE 选项后加上标签文件的名称即可。
要将一个或多个外部项目的输出与您自己的项目结合起来,您应该在配置文件中的 TAGFILES 选项后指定标签文件的名称。
标签文件通常只包含文档相对于 Doxygen 运行位置的相对路径。因此,当您在其他项目中包含标签文件时,必须指定外部文档相对于此项目的位置。您可以通过在配置文件中的 TAGFILES 配置选项后为指定的标签文件分配(相对)位置来做到这一点。如果您使用相对路径,它应该是相对于生成您项目 HTML 输出的目录;也就是说,是从一个项目的 HTML 输出目录到所链接的另一个项目的 HTML 输出目录的相对路径。
proj
使用了两个名为 ext1
和 ext2
的外部项目。目录结构如下所示<root> +- proj | +- html HTML output directory for proj | +- src sources for proj | |- proj.cpp +- ext1 | +- html HTML output directory for ext1 | |- ext1.tag tag file for ext1 +- ext2 | +- html HTML output directory for ext2 | |- ext2.tag tag file for ext2 |- proj.cfg Doxygen configuration file for proj |- ext1.cfg Doxygen configuration file for ext1 |- ext2.cfg Doxygen configuration file for ext2
OUTPUT_DIRECTORY = proj INPUT = proj/src TAGFILES = ext1/ext1.tag=../../ext1/html \ ext2/ext2.tag=../../ext2/htmlext1.cfg
OUTPUT_DIRECTORY = ext1 GENERATE_TAGFILE = ext1/ext1.tagext2.cfg
OUTPUT_DIRECTORY = ext2 GENERATE_TAGFILE = ext2/ext2.tag