doxygen如何超链接到相关页面

时间:2013-09-09 13:45:11

标签: doxygen

我是doxygen的新手,我无法找到语法来创建从主页面到相关页面部分中特定页面的链接。

例如,我正在寻找类似的东西:

http://portaudio.com/docs/v19-doxydocs/index.html

fox例子:

PortAudio API概述 - >这是相关页面的链接。

PortAudio API的自顶向下视图,其功能,功能和数据结构

任何想法我该怎么做?

由于 迈克尔

2 个答案:

答案 0 :(得分:8)

这适用于\ref

//! \page handle MyPage
//! text in MyPage

//! Some variable. For additional information look at \ref handle "this cool page"
int myvar;

答案 1 :(得分:1)

您有几种选择:

  • 链接到您创建的外部html

    /*! \mainpage MY TITLE HERE

    * \section intro_sec External resources

    * <a href="link_to_my_external_page.html">My external page</a>

    */

    另见this question on SO

  • 链接到网址或电子邮件:

    <http://www.example.com>

    <https://www.example.com>

    <ftp://www.example.com>

    <mailto:address@example.com>

    <address@example.com>

    另请参阅documentation of doxygen

PS。转到您提供的示例,让浏览器显示该页面的代码。这可能有助于您理解语法的基本原理。