使用doxygen的\ link命令

时间:2011-05-27 16:02:05

标签: doxygen doxywizard

我有一个外部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. 重建我的文档

  4. 这增加了我的doxygen“主页”以下

    MY TITLE HERE
    
    My external page (which was a link to that page)
    

5 个答案:

答案 0 :(得分:13)

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

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

以上内容应略微接近:


外部资源

My external page


答案 1 :(得分:12)

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

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

cdiggins' answer也值得一读。

答案 2 :(得分:3)

\ link(以及任何形式\ command或@command)被称为“特殊命令”,是Doxygen处理的输入文件中使用的标记的一部分,而不是配置的一部分。 \link command没有做你想做的事。

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

答案 3 :(得分:0)

您可以使用自定义布局文件将标签添加到主导航栏(带链接)。

查看Doxygen手册的Customizing the Output页面。假设我理解你的问题,那就很清楚如何做到这一点。

答案 4 :(得分:0)

这里的其他答案看起来像初学者一样,这是完整的程序。

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>

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