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# / .NET XML tag <para> not working in html output (Origin: bugzilla #664718) #4474

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

Comments

Projects
None yet
1 participant
@doxygen
Owner

doxygen commented Jul 2, 2018

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

On 2011-11-24 11:21:48 +0000, fheuer@oekodata.de wrote:

Hallo doxygen,

you did a fine work, have I ever told you? Here is a bug I have not yet found in this bugzilla system:

Because I am not that kind of developer writing too little documentation, I need the XML documentation tag defined in the C# standard to have paragraphs in the generated documentation. Here is my example code:

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;

namespace doxybug
{
///


/// This is paragraph one
/// with some linebreak in the code
/// this is paragraph two
///

class doxybug
{
///
/// this is para one
/// this is para two
///

public doxybug()
{
}
}
}

When I generate the HTML documentation via doxygen, there are only paragraphs in the class documentation and not in the method documentation. Also in both, the summary concatentated the text resulting in (i.e.) "... linebreak in the codethis is paragraph ...". I have never written the word "codethis". This is just an example and I have tried a lot with this tag, but it does not work like I expected.

Have a look at this and think about the tag as well.

On 2011-11-26 23:07:59 +0000, Dimitri van Heesch wrote:

Confirmed. Should be fixed in the next subversion update.

On 2011-11-29 13:19:03 +0000, fheuer@oekodata.de wrote:

Hallo Dimitri van Heesch,

great that you confirmed my findings. Here is another advice: Think about that bug more general. My example just shows it with the documentation of the class, but I have found this bug in documentations of methods as well. It seem to be a more general bug. So test it with enums, properties, delegates and of course even with partial classes as well.
But it's a shame anyway, that the C# Standard is unclear here as well. So what kind of standard is this, that is unclear?

Thanks a lot.

On 2011-12-03 18:23:04 +0000, Dimitri van Heesch wrote:

This bug was previously marked ASSIGNED, which means it should be fixed in
doxygen version 1.7.6. 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.

On 2011-12-05 07:24:52 +0000, fheuer@oekodata.de wrote:

Hallo Dimitri van Heesch,

you did a great work so far and this bug fix was very fast. I tested it and it works in the summary of the class or method description and also in the detailed description.
But the single tag does not. But where does this tag come from? Some developer use this, but I didn't find it in the C# specification. So it depends on you, if you want to fix this or not.

So far, to my opinion, this bug could be marked "solved".

Thanks

@doxygen doxygen closed this Jul 19, 2018

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment