使用doxygen的\link命令

Question

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

所以，\link是我要将其纳入我的doxygen配置文件还是在构建HTML时添加它？

更新

所以最终我必须执行以下步骤：

1. 创建一个新页面(docs_main.html)，其中包含以下内容：

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

2. 将该页面包含在我的doxygen包含文件列表中

3. 重新生成我的文档

这将会把该页面添加到我的doxygen“主页”中

MY TITLE HERE

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

- Jason

Answer 1

我们现在在doxygen中支持Markdown语法。你的代码可能会更清晰：

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

上述内容大致应该呈现为：

---

外部资源

我的外部页面链接

---

- Janusz Lenar

Answer 2

Doxygen允许您在文档中插入特定的HTML命令，包括链接。如果您不知道，这是在HTML中创建链接的方法：

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

cdiggins' answer 也值得一读。

- David Grayson

Answer 3

\link（和任何形式的\command或@command）被称为“特殊命令”，是Doxygen处理输入文件时使用的标记语言的一部分，而不是配置的一部分。 \link 命令不能满足您的需求。

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

- cdiggins

Answer 4

作为初学者，这里的其他答案可能有些零散。以下是完整的步骤：

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>我的外部页面</b></a>

注意：如果文件无法打开，请尝试提供绝对路径

- rakshi

Answer 5

您可以通过使用自定义布局文件向主导航栏添加选项卡（包含您的链接）。

请查看Doxygen手册中的自定义输出页面。如果我理解您的问题，它非常清楚地说明了如何操作。

- andrezsanchez