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 678180 - Error generating svg graphs in case of a double dash in brief description
Error generating svg graphs in case of a double dash in brief description
Status: VERIFIED FIXED
Product: doxygen
Classification: Other
Component: general
1.8.1.1-SVN
Other Windows
: Normal normal
: ---
Assigned To: Dimitri van Heesch
Dimitri van Heesch
Depends on:
Blocks:
 
 
Reported: 2012-06-15 17:51 UTC by albert
Modified: 2012-07-22 11:19 UTC
See Also:
GNOME target: ---
GNOME version: ---


Attachments
Example: Error generating svg graphs in case of a double dash in brief description (105.80 KB, application/x-compressed-tar)
2012-06-15 17:51 UTC, albert
Details

Description albert 2012-06-15 17:51:10 UTC
Created attachment 216534 [details]
Example: Error generating svg graphs in case of a double dash in brief description

In case there is a double dash in the brief description of a routine a (caller / callee) svg graph is generated with in the text – when displaying this in Firefox an error message is generated like:

XML Parsing Error: undefined entity
Location: file:///D:/doxygen_bugs/bug_svg/html/aa_8f90_aa86c5ee9dff5b110f4ba85c9ef20f876_icgraph.svg
Line Number 19, Column 1:<a xlink:href="aa_8f90.html#a7862ceac94fe0e5c443b4ab538e77530" target="_top" xlink:title="text with a double dash &ndash; in it">


When displaying the same file in Internet Explorer this error does not occur.

When looking at the XML recommendation (Extensible Markup Language (XML) 1.0 (Fifth Edition), http://www.w3.org/TR/xml/ ) and specifically at paragraph 4.6 (Predefined Entities, http://www.w3.org/TR/xml/#sec-predefined-ent) we see that there are only 5 predefined entities: &amp;, &lt;, &gt;, &apos;, &quot;

The &ndash; "enters" the code in commentscan.l at line 1121 and I think that before the generation of the svg graph this has to be reverted (in the input file for the dot processor in case of the svg output format). 


See attachment for an example.
Comment 1 Dimitri van Heesch 2012-06-16 22:01:32 UTC
Indeed. 

Inside util.cpp function parseCommentAsText(), the line with

   QCString result = s.data();

should become

   QCString result = convertCharEntitiesToUTF8(s.data());

Regards,
  Dimitri
Comment 2 Dimitri van Heesch 2012-07-12 15:41:54 UTC
This bug was previously marked ASSIGNED, which means it should be fixed in
doxygen version 1.8.1.2. 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.
Comment 3 albert 2012-07-22 11:19:29 UTC
Works as described, graphs are shown properly now