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 738173 - Entity references in XML code command are incorrectly handled
Entity references in XML code command are incorrectly handled
Status: RESOLVED FIXED
Product: doxygen
Classification: Other
Component: general
1.8.8
Other Windows
: Normal normal
: ---
Assigned To: Dimitri van Heesch
Dimitri van Heesch
Depends on:
Blocks:
 
 
Reported: 2014-10-08 19:22 UTC by Carl Reinke
Modified: 2014-12-25 16:02 UTC
See Also:
GNOME target: ---
GNOME version: ---


Description Carl Reinke 2014-10-08 19:22:17 UTC 
Given the following documentation comment (which is valid according to whatever
tool Visual Studio invokes to produce a documentation XML file from C# code),

    /// <summary>Foo.</summary>
    /// <remarks>Bar.</remarks>
    /// <code>
    /// var s = new HashSet&lt;string&gt;();
    /// </code>

doxygen produces HTML documentation such that the HTML document contains

    new HashSet&amp;lt;<span class="keywordtype">string</span>&amp;gt;();

which renders as

    new HashSet&lt;string&gt;();
Comment 1 Ben Spiller 2014-12-18 15:38:14 UTC 
+1 for this - it's a really serious bug and is making it very difficult for us to use doxygen. The whole point of the C# XML input format is that it's valid XML, and Visual Studio will complain or even fail to compile in some cases if it isn't, so it's important that doxygen can cope with &lt; &gt; entity references to specify the < and > characters in code snippets like this. 

It should be pretty simple to implement a find-replace preprocessor step for key XML entities such as < and > (and it could be a configurable option if needed for backwards compatibility reasons)
Comment 2 Dimitri van Heesch 2014-12-23 15:26:50 UTC 
Confirmed. Should be fixed in the next GIT update.
Comment 3 Dimitri van Heesch 2014-12-25 16:02:28 UTC 
This bug was previously marked ASSIGNED, which means it should be fixed in
doxygen version 1.8.9. 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 (preferrably in the form of a self-contained example).