After an evaluation, GNOME has moved from Bugzilla to GitLab. Learn more about GitLab.
No new issues can be reported in GNOME Bugzilla anymore.
To report an issue in a GNOME project, go to GNOME GitLab.
Do not go to GNOME Gitlab for: Bluefish, Doxygen, GnuCash, GStreamer, java-gnome, LDTP, NetworkManager, Tomboy.
Bug 619978 - Links to html referenced from tagfile are broken in source file pages
Links to html referenced from tagfile are broken in source file pages
Status: RESOLVED FIXED
Product: doxygen
Classification: Other
Component: build
1.6.3
Other Windows
: Normal normal
: ---
Assigned To: Dimitri van Heesch
Dimitri van Heesch
Depends on:
Blocks:
 
 
Reported: 2010-05-28 20:13 UTC by csuehara
Modified: 2010-06-15 11:21 UTC
See Also:
GNOME target: ---
GNOME version: ---

Attachments
Example of the tagfile path differences between class and file documentation (37.62 KB, application/octet-stream)
2010-05-30 22:45 UTC, csuehara 		Details

Description csuehara 2010-05-28 20:13:40 UTC 
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.
Comment 1 Dimitri van Heesch 2010-05-30 19:12:02 UTC 
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
?
Comment 2 csuehara 2010-05-30 22:45:23 UTC 
Created attachment 162350 [details]
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.
Comment 3 Dimitri van Heesch 2010-06-01 20:30:18 UTC 
Confirmed. Should be fixed in the next subversion update.
Comment 4 Dimitri van Heesch 2010-06-15 11:21:55 UTC 
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.