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

Entity references in XML code command are incorrectly handled (Origin: bugzilla #738173) #5653

doxygen opened this Issue Jul 2, 2018 · 0 comments


None yet
1 participant

doxygen commented Jul 2, 2018

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

On 2014-10-08 19:22:17 +0000, Carl Reinke wrote:

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;();

On 2014-12-18 15:38:14 +0000, Ben Spiller wrote:

+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 < > 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)

On 2014-12-23 15:26:50 +0000, Dimitri van Heesch wrote:

Confirmed. Should be fixed in the next GIT update.

On 2014-12-25 16:02:28 +0000, Dimitri van Heesch wrote:

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).

@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