Problems with enum Documentation (NDoc Problem?)

M

Mark Johnson

No "Description" in resulting HTML File using NDOC (Version 1.2.1303.41457).

From the Framework side I think I am doing everything correctly, because the
resulting
XML has the coments.

Is this a known NDoc problem?
Is there a NDoc newsgroup?

C# :

public enum Back
{
/// Crosshatch/CROSSHATCH (0) - CardsDll (53)
Crosshatch,
....
}

resulting XML :

<member name="F:mj10777_Cards.Back.Crosshatch">
Crosshatch/CROSSHATCH (0) - CardsDll (53)
</member>

Mark Johnson, Berlin Germany
(e-mail address removed)
 
P

Peter Foot [MVP]

You should use summary tags:-

public enum Back
{
///<summary>
/// Crosshatch/CROSSHATCH (0) - CardsDll (53)
///</summary>
Crosshatch,
...
}

Peter
 
M

Mark Johnson

Ahh, what a good answer to a stupid question.

It works very well.

Thank you,

Mark Johnson, Berlin Germany
(e-mail address removed)
 

Ask a Question

Want to reply to this thread or ask your own question?

You'll need to choose a username for the site, which only take a couple of moments. After that, you can post your question and our members will help you out.

Ask a Question

Top