c++ - 如何交叉引用现有的 doxygen 文档？

Question

我有两个 C++ 项目 A 和 B；依赖只是 B 到 A。

B  --> A

我想分别在 A 和 B 上分别运行 Doxygen，但仍然允许我从 B 文档对 A 进行交叉引用。 (也就是说，当我浏览B文档时，如果B中使用了A中的任何类，我可以直接链接到A文档)。

--

[回复了0x4b的答案:]如果我将“CREATE_SUBDIRS”设置为 YES 并使用标记文件的相对路径，Doxygen 将以某种方式产生错误的链接引用。

我确实按照这个例子做了。

 <root>
    +- proj
    |   +- html               HTML output directory for proj   
    |       +- d1
    |       |   +- d2
    |       |       .... (*.html)
    |       | 
    |         ...(*.html)
    |   +- src                sources for proj
    +- ext1
    |   +- html               HTML output directory for ext1
    |   |- ext1.tag           tag file for ext1
    |- proj.cfg               doxygen configuration file for proj
    |- ext1.cfg               doxygen configuration file for ext1

proj.cfg:
OUTPUT_DIRECTORY  = proj
INPUT             = proj/src
TAGFILES          = ext1/ext1.tag=../../ext1/html

ext1.cfg:
OUTPUT_DIRECTORY  = ext1
GENERATE_TAGFILE  = ext1/ext1.tag 

html/ 和 html/d1/d2 下的文档都想尝试链接位于 ../../ext1/html 的外部文档。显然其中之一会失败。

Answer 1

您可能想使用 tagfile feature .当您为 A 生成文档时，请确保设置了 GENERATE_TAGFILE 选项。当您为 B 生成文档时，设置 TAGFILES 的值以包含来自 A 的结果。

[更新以解决相对路径]

Doxygen 在涉及[相对] 路径时相当脆弱。你清楚地明白，使用绝对路径就可以解决问题。您可以尝试从环境中获取值(value)，例如使用

TAGFILES          = ext1/ext1.tag=$(PWD)/../ext1/html

创建绝对路径。这并不理想，但 Doxyfile 中的许多值取决于 doxygen 的运行位置，而不是配置文件所在的位置。