如果您的项目依赖于外部库或工具,有多种原因不希望每次运行 Doxygen 时都包含这些库或工具的所有源代码。
如果外部包及其文档是其他人拥有版权的,最好(甚至可能必要)引用它,而不是将其副本包含在您的项目文档中。如果作者禁止重新分发,则此操作是必需的。如果作者要求您在重新分发前遵守某些许可条件,而您不想受这些条件的约束,引用他们的文档副本比包含副本更可取。
如果以上任何一种情况适用,您都可以使用 Doxygen 的标签文件机制。标签文件基本上是对外部源代码中实体的一种紧凑表示。Doxygen 可以生成和读取标签文件。
要为您的项目生成标签文件,只需在配置文件中的 GENERATE_TAGFILE 选项后添加标签文件的名称即可。
要将一个或多个外部项目的输出与您自己的项目结合起来,您应该在配置文件中的 TAGFILES 选项后指定标签文件的名称。
标签文件通常只包含自 Doxygen 运行以来文档的相对位置。因此,当您在其他项目中包含标签文件时,您必须指定外部文档相对于该项目的位置。您可以在配置文件中通过为 TAGFILES 配置选项指定的标签文件分配(相对)位置来完成此操作。如果您使用相对路径,它应该是相对于生成项目 HTML 输出的目录;因此,这是一个从一个项目的 HTML 输出目录到要链接到的其他项目的 HTML 输出目录的相对路径。
<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/html
ext1.cfgOUTPUT_DIRECTORY = ext1 GENERATE_TAGFILE = ext1/ext1.tagext2.cfg
OUTPUT_DIRECTORY = ext2 GENERATE_TAGFILE = ext2/ext2.tag