doxygen how to hyperlink to related page

Question

I am new to doxygen and i could not find the syntax for me to create a link from main page to a specific page in the related pages section.

For example , i am looking for something similar to this :

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

fox example:

PortAudio API Overview -> This is a link to related page.

A top-down view of the PortAudio API, its capabilities, functions and data structure

Any ideas how can i do that ?

Thanks Michael

Answer 1

You have several options:

• link to an external html you created:

  /*! \mainpage MY TITLE HERE

  * \section intro_sec External resources

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

  */

  see also this question on SO.

• link to an URL or e-mail:

  <http://www.example.com>

  <https://www.example.com>

  <ftp://www.example.com>

  <mailto:address@example.com>

  <address@example.com>

  see also the documentation of doxygen.

PS. Go to the example you provided and let your browser show you the code of the page. This might help you to understand basic principles of syntax.

Answer 2

This should work with \ref

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

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