链接到外部主页

时间:2012-07-28 11:05:53

标签: documentation doxygen documentation-generation

我制作了一个Doxygen文档,它本身使用标记文件机制引用了另一个文档。但是在其主页中,我现在想要链接到外部文档的主页。当然,我总是可以直接指定文件:

... uses [OtherDoc](../../../OtherProject/doc/html/index.html) for ...

因为项目相对于彼此而言更是如此。但是,我希望Doxygen能够自动化这个过程,因为无论如何它都需要知道外部文档的位置。

有没有办法以某种方式象征性地引用外部文档的主页,类似于:

[OtherDoc](\ref OtherProject::mainpage)

[OtherDoc](#OtherProject::mainpage)

1 个答案:

答案 0 :(得分:2)

有一个技巧可以做到这一点。假设你有项目A和B,那么在项目A的主页面中你可以像这样放一个@anchor命令:

/** @mainpage
 *  @anchor project_a
 */

在项目b的文档中,您可以简单地使用

 [OtherDoc](\ref project_a)

请注意,锚点必须是全局唯一的,因此您需要仔细选择它们!