doxygen - 使用 doxygen 的 \link 命令

Question

我有一个外部 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)

score 15 · Accepted Answer

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

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

上面应该呈现有点接近：

外部资源

score 12 · Accepted Answer

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

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

score 4 · Accepted Answer

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

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

score 1 · Accepted Answer

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

1）创建一个内容如下的html文件（例如：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>

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

score 0 · Accepted Answer

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

查看 Doxygen 手册的自定义输出页面。假设我理解你的问题，如何做到这一点很清楚。