doxygen как гиперссылка на связанную страницу

Question

Я новичок в doxygen, и я не смог найти синтаксис для меня, чтобы создать ссылку с главной страницы на определенную страницу в разделе связанных страниц.

Например, я ищу что-то похожее на это:

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

лисица пример:

Portaudio Обзор API -> Это ссылка на соответствующую страницу.

Вид сверху вниз по API Portaudio, его возможностей, функций и структуры

Любые идеи, как я могу сделать это данные?

Благодаря Майкл

Answer 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.

• ссылка на URL или по электронной почте:

  <http://www.example.com>

  <https://www.example.com>

  <ftp://www.example.com>

  <mailto:address@example.com>

  <address@example.com>

  см. Также documentation of doxygen.

PS. Перейдите к примеру, который вы предоставили, и пусть ваш браузер покажет вам код страницы. Это может помочь вам понять основные принципы синтаксиса.

Answer 2

Это должно работать с \ref

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

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