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 :

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

score 12 · Answer 1 · answered Apr 15 '15 at 14:02

12

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;

answered Apr 15 '15 at 14:02

kuga

3

And to link the main page, use `\ref index "Link to the main page"` – Boris Dalstein Mar 02 '16 at 03:20
Link to related pages can be achieved (in `\htmlonly`) as `Related Pages`. Though this is likely a bit fragile, it seems to be the only way to link that right now. – the swine Aug 24 '17 at 21:45
2

@theswine This is not true. It can be easely done by `[Related Pages](pages.html)` and also e.g. `[Related Page](https://exmaple.com)`. Same can also be used in combination with e.g. `\ref` and `\subpage` like `[Related internal Page](\ref someLable)` – derHugo Oct 30 '17 at 08:47
Rather nicely, `\ref handle` on its own will use the title of the target page as the displayed name. – carthurs Sep 11 '18 at 13:27

score 0 · Answer 2 · edited Mar 24 '19 at 14:50

0

You have several options:

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.

edited Mar 24 '19 at 14:50

albert

answered Sep 09 '13 at 14:37

fiscblog

2

He wants to do an internal link, not an external link! – kuga Apr 15 '15 at 14:05

2 Answers2