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

Links to html referenced from tagfile are broken in source file pages (Origin: bugzilla #619978) #3786

Closed
doxygen opened this Issue Jul 2, 2018 · 0 comments

Comments

Projects
None yet
1 participant
@doxygen
Owner

doxygen commented Jul 2, 2018

status RESOLVED severity normal in component build for ---
Reported in version 1.6.3 on platform Other
Assigned to: Dimitri van Heesch

Original attachment names and IDs:

On 2010-05-28 20:13:40 +0000, csuehara@gmail.com wrote:

Generate documentation that uses a tagfile.

If layout is:

src/proj1

doc/proj1/HTML
doc/proj2/HTML

and the doxyfile in src/proj1 includes:

TAGFILES = ../doc/proj2/proj2.tag=../../../../proj2/html

CREATE_SUBDIRS = YES

the proj1 documentation for classes contains proper links to proj2/html files, but the links in the included source files include an additional ../../ prepended to the relative path specified in the doxyfile's TAGFILES field.

On 2010-05-30 19:12:02 +0000, Dimitri van Heesch wrote:

I guess you have CREATE_SUBDIRS enabled, in which case doxygen will add the ../.. where needed and you should not do this in the TAGFILES line. If you found a case where the result is not correct, then please attach a self-contained example (source + config file in a zip or tar) that allows me to reproduce the problem.

As a workaround: does it help to disable CREATE_SUBDIRS and use
TAGFILES = ../doc/proj2/proj2.tag=../../proj2/html
?

On 2010-05-30 22:45:23 +0000, csuehara@gmail.com wrote:

Created attachment 162350
Example of the tagfile path differences between class and file documentation

In the attached example, the tagfile reference in the proj1 doxyfile is:

CREATE_SUBDIRS = YES
TAGFILES = ../doc/proj2/proj2.tag=../../proj2/html/

If you go to the generated CProj1 class documentation, the brief description has a broken link to the CProj2 class document.

If you go to the documentation for proj1.hpp, the link to the CProj2 class document is fine.

Since the class documentation is most important, I've been using:

CREATE_SUBDIRS = YES
TAGFILES = ../doc/proj2/proj2.tag=../../../../proj2/html/

This fixes the links in the class documentation but leaves the links broken in the file docs.

This is using doxygen on Windows.

On 2010-06-01 20:30:18 +0000, Dimitri van Heesch wrote:

Confirmed. Should be fixed in the next subversion update.

On 2010-06-15 11:21:55 +0000, Dimitri van Heesch wrote:

This bug was previously marked ASSIGNED, which means it should be fixed in
doxygen version 1.7.0. Please verify if this is indeed the case. Reopen the
bug if you think it is not fixed and please include any additional information
that you think can be relevant.

@doxygen doxygen closed this Jul 2, 2018

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment