【问题标题】:Use equivalent of InterWiki links in doxygen documentation markup在 doxygen 文档标记中使用等效的 InterWiki 链接
【发布时间】:2016-11-20 17:28:56
【问题描述】:

我的一些 doxygen 文档需要参考 公司的维基。如果这些参考资料能奏效,我会更愿意 生成的文档中的超文本链接。我当然可以 通过写作实现这一点:

/// <a href="http:://long-URL.com/wiki/index.php?Name-of-page">Name of page</a>

或者使用 Markdown 语法:

/// [Name of wiki page](http://long-URL.com/wiki/index.php?Name-of-page)

不幸的是,在这两种情况下,我都必须在每个链接中提供完整的 URL, 以及何时(正如已经发生的那样)我们公司/wiki 的基本 URL 更改,所有 URL 都需要更新。

因此,我想知道 Doxygen 是否有一些支持以避免不得不 对每个链接的整个 URL 进行硬编码?

为了比较,wiki 使用“InterMap”或“InterWiki”来定义 允许使用速记符号快速引用页面的前缀 在另一个网站上。示例:

See WikiPedia:InterWiki_Links for more details.

所以如果可能的话,我想让 Doxygen 文档包含 类似:

// See CompanyWiki:Name_of_wiki_page for bla bla

一些参考资料:

【问题讨论】:

    标签: doxygen


    【解决方案1】:

    你可以在配置文件中定义一个别名:

    ALIASES += WikiPedia{2}="<a href=\"http://long-URL.com/wiki/index.php?\1\">\2</a>"
    

    然后像这样在你的 cmets 中使用它

    See \WikiPedia{InterWiki_Links,Interwiki Links} for more details.
    

    另请参阅http://www.doxygen.org/manual/custcmd.html 了解更多信息。

    【讨论】:

      猜你喜欢
      • 1970-01-01
      • 1970-01-01
      • 2022-06-14
      • 1970-01-01
      • 2013-10-17
      • 1970-01-01
      • 1970-01-01
      • 2014-07-02
      • 2016-07-04
      相关资源
      最近更新 更多