【问题标题】:Link to external mainpage链接到外部主页
【发布时间】:2012-07-28 11:05:52
【问题描述】:

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

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

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

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

[OtherDoc](\ref OtherProject::mainpage)

[OtherDoc](#OtherProject::mainpage)

【问题讨论】:

  • 如果你关闭你的开放赏金,我会添加一个更高的。
  • 非常好的问题。我们可能不得不等到赏金期结束。

标签: documentation doxygen documentation-generation


【解决方案1】:

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

/** @mainpage
 *  @anchor project_a
 */

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

 [OtherDoc](\ref project_a)

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

【讨论】:

  • 既然答案直接来自您,我可以假设这是实现这一目标的最佳和最直接的方法?
  • 现在的问题只是,链接打开的页面稍微向下滚动(使主页的标题消失),因为我必须将锚点放在{#mainpage}-labeled 标题下方,以便要正确识别为主页的降价文件。但我也许可以忍受,至少现在离目标更近了一步。
  • 最好的解决方案是明确告诉 doxygen 在哪里寻找符号,这样你就可以使用像 \ref a.tag:index 这样的东西来引用项目 A 的索引页面。不过,目前尚未实施。
  • 这个问题还没解决吗?
猜你喜欢
  • 1970-01-01
  • 1970-01-01
  • 1970-01-01
  • 1970-01-01
  • 2017-11-18
  • 1970-01-01
  • 2017-12-27
  • 2020-09-09
  • 1970-01-01
相关资源
最近更新 更多