在 Doxygen 文档标记中使用等效的 InterWiki 链接
Use equivalent of InterWiki links in doxygen documentation markup
我的一些 doxygen 文档需要参考
公司的维基。如果这些引用导致工作,我更愿意
生成文档中的超文本 links。我当然可以
通过写作实现这一点:
/// <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)
不幸的是,在这两种情况下,我都必须在每个 link 处给出完整的 URL,
以及什么时候(已经发生了)我们 company/wiki 的基础 URL
更改,所有 URL 都需要更新。
因此我想知道 Doxygen 是否有一些支持来避免必须
在每个 link?
处对整个 URL 进行硬编码
为了比较,wiki 使用 "InterMap" 或 "InterWiki" 来定义
允许使用 shorthand 符号快速引用页面的前缀
在另一个网站上。示例:
See WikiPedia:InterWiki_Links for more details.
所以如果可能的话我想让Doxygen文档包含
类似于:
// See CompanyWiki:Name_of_wiki_page for bla bla
部分参考资料:
- 自动 link 生成 - http://www.doxygen.nl/manual/autolink.html
- InterWiki - https://www.mediawiki.org/wiki/Manual:Interwiki
- PmWiki/InterMap - http://www.pmwiki.org/wiki/PmWiki/InterMap
您可以在配置文件中定义一个别名:
ALIASES += WikiPedia{2}="<a href=\"http://long-URL.com/wiki/index.php?\"></a>"
然后像这样在你的评论中使用它
See \WikiPedia{InterWiki_Links,Interwiki Links} for more details.
另请参阅 http://www.doxygen.org/manual/custcmd.html 了解更多信息。
我的一些 doxygen 文档需要参考 公司的维基。如果这些引用导致工作,我更愿意 生成文档中的超文本 links。我当然可以 通过写作实现这一点:
/// <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)
不幸的是,在这两种情况下,我都必须在每个 link 处给出完整的 URL, 以及什么时候(已经发生了)我们 company/wiki 的基础 URL 更改,所有 URL 都需要更新。
因此我想知道 Doxygen 是否有一些支持来避免必须 在每个 link?
处对整个 URL 进行硬编码为了比较,wiki 使用 "InterMap" 或 "InterWiki" 来定义 允许使用 shorthand 符号快速引用页面的前缀 在另一个网站上。示例:
See WikiPedia:InterWiki_Links for more details.
所以如果可能的话我想让Doxygen文档包含 类似于:
// See CompanyWiki:Name_of_wiki_page for bla bla
部分参考资料:
- 自动 link 生成 - http://www.doxygen.nl/manual/autolink.html
- InterWiki - https://www.mediawiki.org/wiki/Manual:Interwiki
- PmWiki/InterMap - http://www.pmwiki.org/wiki/PmWiki/InterMap
您可以在配置文件中定义一个别名:
ALIASES += WikiPedia{2}="<a href=\"http://long-URL.com/wiki/index.php?\"></a>"
然后像这样在你的评论中使用它
See \WikiPedia{InterWiki_Links,Interwiki Links} for more details.
另请参阅 http://www.doxygen.org/manual/custcmd.html 了解更多信息。