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 773162 - Doxygen adds underscore characters to links
Doxygen adds underscore characters to links
Status: RESOLVED FIXED
Product: doxygen
Classification: Other
Component: documentation
1.8.12
Other Linux
: Normal major
: ---
Assigned To: Dimitri van Heesch
Dimitri van Heesch
Depends on:
Blocks:
 
 
Reported: 2016-10-18 13:52 UTC by diarmuid.kieran
Modified: 2016-12-29 18:45 UTC
See Also:
GNOME target: ---
GNOME version: ---


Attachments
Demonstrates how the broken link is generated (272.44 KB, application/x-zip-compressed)
2016-10-19 08:23 UTC, diarmuid.kieran
Details

Description diarmuid.kieran 2016-10-18 13:52:15 UTC
In 1.8.10, whenever there was a line as follows in a source file:

include "folderA/fileX.h" 
the link was constructed as follows:

href="../folderA/fileX_8h.html" 
However, since I upgraded to 1.8.12, the link changes, and becomes:

href="../folderA/fileX__8h.html" 
An additional underscore is added before the "8h.html".

In fact, every link such as this with a single underscore now has a double underscore. So, for example

href="../folderA/folderB_fileX_8h.html"
has become

 href="../folderA/folderB__fileX__8h.html"
As a result I have lots of broken links.
Comment 1 diarmuid.kieran 2016-10-19 08:23:02 UTC
Created attachment 337997 [details]
Demonstrates how the broken link is generated

Using Doxygen 1.8.12, with the default Doxygen properties file.
Unzip the folders TestA and TestB.
Generate the documentation of TestB. 
Generate the documentation of TestA (You will have to change the TAGFILES property first to the correct path for the TestB tag file for your system)

Open the TestA library and go to the html/index.html page.
Click on the link to TestB/TestBHeader.h on the TestAExample1_8cc-example.html page. The link goes to TestB/TestBHeader__8h.html (with two underscores). 
Also, click on the link to TestB/TestBHeader.h on the TestAHeader_8h.html page or the TestAHeader_8h_source.html page. In both cases, the link has two underscores (TestB/TestBHeader__8h.html).
This produces a broken link. If you check the TestB documentation, you can see that the page in question only has one underscore (TestB/TestBHeader_8h.html).

If I generate the equivalent documentation using Doxygen 1.8.10, I do not have this problem.
I have not installed 1.8.11 so I have not tried it with that version.
Comment 2 Dimitri van Heesch 2016-12-26 10:57:57 UTC
Confirmed. This bug should already be fixed in the latest GIT update.
Comment 3 Dimitri van Heesch 2016-12-29 18:45:49 UTC
This bug was previously marked ASSIGNED, which means it should be fixed in
doxygen version 1.8.13. 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 (preferably in the form of a self-contained example).