Link to external mainpage

Question

I have made a Doxygen documentation, which itself references another documentation using the tag-file mechanism. But inside its mainpage I now would like to link to the mainpage of the external documentation. Of course, I can always specify the file directly:

... uses [OtherDoc](../../../OtherProject/doc/html/index.html) for ...

even more so since the projects are located relative to each other. But nevertheless I would like Doxygen to automate this process, since it needs to know the location of the external documentation, anyway.

So is there a way to somehow symbolically reference the external documentation's mainpage, something along the lines of:

[OtherDoc](\ref OtherProject::mainpage)

or

[OtherDoc](#OtherProject::mainpage)

Very good question. We will probably have to wait till the end of the bounty period. — pmr
– pmr, Commented Jul 30, 2012 at 15:05

doxygen · Accepted Answer · 2012-07-30 17:35:21Z

3

+50

There is a trick to do this. Say you have projects A and B, then in the main page of project A you could put an @anchor command like so:

/** @mainpage
 *  @anchor project_a
 */

And in the documentation of project b you can then simply use

 [OtherDoc](\ref project_a)

Note that anchors have to be globally unique, so you need to carefully choose them!

answered Jul 30, 2012 at 17:35

doxygen

15k2 gold badges45 silver badges40 bronze badges

Sign up to request clarification or add additional context in comments.

4 Comments

Christian Rau Over a year ago

Since the answer comes directly from you, I can assume this is the best and most direct way to achieve this?

Christian Rau Over a year ago

The problem is now only, that the link opens the page slightly scrolled down (making the mainpage's title disappear), because I have to place the anchor below the {#mainpage}-labeled heading, in order for the markdown file to be correctly recognized as mainpage. But I may be able to live with that, at least the goal is a step nearer now.

doxygen Over a year ago

The best solution would be to have a way to explicitly tell doxygen where to look for a symbol, so you could use something like \ref a.tag:index to refer to project A's index page. That's currently not implemented though.

iAdjunct Over a year ago

Has this still not been fixed?

Collectives™ on Stack Overflow

Link to external mainpage

1 Answer 1

4 Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

4 Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related