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

C# <code> tag in an <example> tag does not render as expected. (Origin: bugzilla #685597) #4914

Closed
doxygen opened this Issue Jul 2, 2018 · 0 comments

Comments

Projects
None yet
1 participant
@doxygen
Owner

doxygen commented Jul 2, 2018

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

Original attachment names and IDs:

On 2012-10-06 01:55:46 +0000, jdknight wrote:

Created attachment 225918
Code Snippet Showing XML Tag Usage

Documenting some C# code with the and tags does not render the code nicely on the documentation page. However, when using with the tag, code appears to render nicely.

I can continue to use the tag as a solution, however, I wish to use the tag to follow the MSDN notes (seen here http://msdn.microsoft.com/en-us/library/9w4cf933(v=vs.80).aspx).

Attached includes a snippet of example code and the image showing the doyxgen HTML output.

On 2012-10-06 01:56:49 +0000, jdknight wrote:

Created attachment 225919
Rendering of C# XML Tagged Code

On 2013-12-17 10:10:14 +0000, David E wrote:

This bug also appears if is used stand alone without any or tags.

On 2014-05-14 12:55:57 +0000, evilfish wrote:

I tested out the using with the tag as well and found something interesting.

If I do this:

//codeblock 1; //codeblock 2;

both code blocks render correctly. It looks like the remarks tag somehow activates the correct code parser for C#

On 2014-10-08 18:49:08 +0000, Carl Reinke wrote:

It seems that even an empty remarks section activates correct C# parsing.

The following renders as expected:

///
///
///
/// ;
/// ;
///

///

The example tag isn't necessary, but it's typical usage.

(Tested using v1.8.8)

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

[1] indicates that both the summary tag and remarks tag should activate XML-comment parsing.

The following also renders as expected:

///


/// Test
///

///
///
///
/// ;
/// ;
///

///

So it seems to be that the first summary tag isn't doing the trick. :(

[1] https://github.com/doxygen/doxygen/blob/SHA: 808b6174027ae53083aab386a7bc0eecc72c7a0d/src/docparser.cpp#L5966

On 2014-12-23 19:04:51 +0000, Dimitri van Heesch wrote:

The problem is that the .. construct is overloaded in doxygen. It is both valid HTML markup that doxygen supports and also valid XML markup, so I made some detection mechanism to switch the parsing into 'XML' mode.

I'll mark all 'primary' tags as listed here:
http://msdn.microsoft.com/en-us/magazine/cc302121.aspx
as triggers for the 'XML' mode.

Should be fixed in the next GIT update.

On 2014-12-25 16:03:22 +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).

On 2015-01-03 21:28:24 +0000, jdknight wrote:

Created attachment 293675
Rendering of C# XML Tagged Code with Doxygen v1.8.9

Verified working in Doxygen v1.8.9. The provided attachment shows the original snippet of code rendering as expected.

Thanks.

@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