在doxygen文档标记中使用等效的InterWiki链接

时间:2016-07-18 07:40:05

标签: doxygen

我的一些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, 以及(当时已经发生过)我们公司/维基的基本URL 更改,所有网址都需要更新。

因此我想知道Doxygen是否有一些支持以避免不得不这样做 在每个链接上对整个网址进行硬编码?

为了比较,wiki使用&#34; InterMap&#34;或者&#34; InterWiki&#34;,来定义 允许快速引用页面的简写符号的前缀 在另一个网站上。例如:

See WikiPedia:InterWiki_Links for more details.

因此,如果可能,我想让Doxygen文档包含 类似的东西:

// See CompanyWiki:Name_of_wiki_page for bla bla

一些参考文献:

1 个答案:

答案 0 :(得分:1)

您可以在配置文件中定义别名:

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

然后在你的评论中使用它

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

有关详细信息,另请参阅http://www.doxygen.org/manual/custcmd.html