【问题标题】：Use of doxygen's \link command使用 doxygen 的 \link 命令
【发布时间】：2011-09-03 12:48:53
【问题描述】：

我有一个外部 HTML 文件，我想链接到我的 doxygen“相关页面”选项卡或左侧框架。看来我需要使用\link 命令，但我找不到一个很好的例子来说明如何使用它或在哪里使用它。我目前正在使用 doxywizard 生成 HTML。

那么，\link 是我合并到我的 doxygen 配置文件中还是在我以某种方式构建 HTML 时添加它？

更新

所以我最终不得不做以下事情：

创建一个包含以下内容的新页面 (docs_main.html)：

/*! \mainpage MY TITLE HERE
 * \section intro_sec External resources
 * <a href="link_to_my_external_page.html">My external page</a>
 */

这在我的 doxygen“主页”中添加了以下内容

MY TITLE HERE

My external page (which was a link to that page)

【问题讨论】：

【解决方案1】：

我们现在在 doxygen 中有 Markdown 支持。您的代码可能更清晰：

/*! \mainpage MY TITLE HERE
 * \anchor intro_sec
 * # External resources
 * [My external page](http://link_to_my_external_page.html)
 */

上面的渲染应该有点接近：

外部资源

【讨论】：

【解决方案2】：

Doxygen 允许您将certain HTML commands 插入到您的文档中，包括链接。如果您不知道这是在 HTML 中创建链接的方式：

<a href="externalfile.html">External file</a>

cdiggins' answer也值得一读。

【讨论】：

【解决方案3】：

\link（以及 \command 或 @command 形式的任何内容）称为“特殊命令”，是 Doxygen 处理的输入文件中使用的标记的一部分，而不是配置的一部分。 \link command 不会做你想做的事。

您或许可以使用\page command 创建一个新的相关页面，然后使用\htmlinclude command 插入外部HTML 文件作为该页面的内容。

【讨论】：

【解决方案4】：

因为这里的其他答案对于初学者来说都是零碎的，所以这里是完整的过程。

1) 创建一个html文件，内容如下(ex:abc.html)

/*! \mainpage MY TITLE HERE 
 * \section intro_sec External resources
 * <a href="link_to_my_external_page.html">My external page</a>
 */

2) 在此处的配置文件中添加此文件路径 INPUT =

3) 还要在此处添加您的文件类型 FILE_PATTERNS =

上述过程在 doxygen 窗口中打开您的文件

添加以下内容以在资源管理器中打开文件

<a href="link_to_my_external_page.html" target="_blank"><b>My external page</b></a>

注意：如果文件没有打开，请尝试给出绝对路径

【讨论】：

【解决方案5】：

您可以使用自定义布局文件将选项卡添加到主导航栏（带有您的链接）。

查看 Doxygen 手册的Customizing the Output 页面。假设我理解了你的问题，如何去做就很清楚了。

【讨论】：