Using C# XML comments to document an Enumeration

[Rhy Mednick]

I can't seem to figure out how to use C# XML comments to document the
members of an enumeration.

Here's an example of what I have so far:

/// <summary>

/// Specifies how ink is to be scaled in relation to its parent control.

/// </summary>

public enum InkScalingMode {None, InkToControl, ControlToInk};

The problem I'm having is that when I generate the documentation (using
NDoc) I get a table showing each of the possible values for the enum but the
descriptions of the values are blank. I expect them to be blank because I
haven't described them anywhere, but I can't seem to figure out what tags to
use to describe them.

Anyone know how to do this?

Thanks,

Rhy

[Rhy Mednick]

Figured it out:
/// <summary>

/// Specifies how ink is to be scaled in relation to its parent control.

/// </summary>

/// <value></value>

public enum InkScalingMode {

/// <summary>

/// Ink will not be scaled.

/// </summary>

None,

/// <summary>

/// Ink will be scaled to the control.

/// </summary>

InkToControl,

/// <summary>

/// Control will be scaled to the ink.

/// </summary>

ControlToInk

};
"Rhy Mednick" <rh*@rhy.com> wrote in message
news:eZ**************@tk2msftngp13.phx.gbl...

I can't seem to figure out how to use C# XML comments to document the
members of an enumeration.

Here's an example of what I have so far:

/// <summary>

/// Specifies how ink is to be scaled in relation to its parent
control.

/// </summary>

public enum InkScalingMode {None, InkToControl, ControlToInk};

The problem I'm having is that when I generate the documentation (using
NDoc) I get a table showing each of the possible values for the enum but
the descriptions of the values are blank. I expect them to be blank
because I haven't described them anywhere, but I can't seem to figure out
what tags to use to describe them.

Anyone know how to do this?

Thanks,

Rhy