Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Can't link to a tagfile page in DoxygenLayout? #10388

Closed
chris-tallman opened this issue Oct 27, 2023 · 5 comments
Closed

Can't link to a tagfile page in DoxygenLayout? #10388

chris-tallman opened this issue Oct 27, 2023 · 5 comments
Labels
bug enhancement a request to enhance doxygen, not a bug

Comments

@chris-tallman
Copy link

Describe the bug
I have been struggling to figure out how to reference an external page with a tagfile within my DoxygenLayout.xml file. I can reference the page elsewhere in my code with @ref external.md and [external](external.md), but not <tab type="user" title="External" url="@ref external.md"/> in the layout navindex.

Expected behavior
I would expect to be able to reference the external page the same way whether it's linked from a documentation page or from the layout file.

To Reproduce
See TagfileLinkInDoxygenLayout.zip.

With this sample, run pushd external && doxygen && popd && doxygen and view the generated html output. Links in the documentation correctly navigate to the external page, but the link in the navigation bar is broken.

Version
Observed in version 1.9.7 and 1.9.8

@albert-github albert-github added the enhancement a request to enhance doxygen, not a bug label Oct 28, 2023
@albert-github
Copy link
Collaborator

It looks like that the general linking into the "blue bar" and treeview has problems.
I did some tests with

  • external
    • page (your test), does not work
    • function, does not work
  • internal
    • page, does not work
    • function, works

whilst when having the same @ref in running text all links do work.

albert-github added a commit to albert-github/doxygen that referenced this issue Oct 28, 2023
Adjusting method for the layout file analogous to the methods used in the msc / dot file generators.

During the working on this issue also a small problem was found (external links didn't work) was found for msc graphs.
@albert-github
Copy link
Collaborator

I've just pushed a proposed patch, pull request #10390

@chris-tallman
Copy link
Author

chris-tallman commented Oct 30, 2023

I tested this branch with both my test project and your extra tests and it works as expected. 👍

doxygen added a commit that referenced this issue Nov 4, 2023
issue #10388 Can't link to a tagfile page in DoxygenLayout?
@albert-github albert-github added the fixed but not released Bug is fixed in github, but still needs to make its way to an official release label Nov 4, 2023
@albert-github
Copy link
Collaborator

Code has been integrated in master on GitHub (please don't close the issue as this will be done at the moment of an official release).

@doxygen
Copy link
Owner

doxygen commented Dec 25, 2023

This issue was previously marked 'fixed but not released',
which means it should be fixed in doxygen version 1.10.0.
Please verify if this is indeed the case. Reopen the
issue if you think it is not fixed and please include any additional information
that you think can be relevant (preferably in the form of a self-contained example).

@doxygen doxygen removed the fixed but not released Bug is fixed in github, but still needs to make its way to an official release label Dec 25, 2023
@doxygen doxygen closed this as completed Dec 25, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug enhancement a request to enhance doxygen, not a bug
Projects
None yet
Development

No branches or pull requests

3 participants