473,327 Members | 2,025 Online
Bytes | Software Development & Data Engineering Community
Post Job

Home Posts Topics Members FAQ

Join Bytes to post your question to a community of 473,327 software developers and data experts.

Using C# XML comments to document an Enumeration

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


Nov 16 '05 #1
1 14818
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

Nov 16 '05 #2

This thread has been closed and replies have been disabled. Please start a new discussion.

Similar topics

0
by: thomas hygum | last post by:
Can php read comments embedded/included in picture files, fx. files of the formats PNG or JPG?
1
by: caldwellj | last post by:
Hello to anyone that can help, Basically, I am trying to design a page with 4 frames which are nested. A left frame and then a right frame with 3 frame rows. <frameset cols="20%,*"> <frame...
0
by: jon morgan | last post by:
Does anyone know how to achieve the equivalent of the following invalid enumeration definition: Public Enum Notes C-2 C#-2 D-2 D#-2 .....
1
by: Piyush Gupta | last post by:
Hi All, I am using following code snippet to add another user in Users.xml: ------------------------------------------------------------------- DataSet dstUsers = new DataSet();...
3
by: Thomas Seidel | last post by:
Hi NG, I would like to write a specific library that gets it data from a specific webpage. Because not all web sites are XHTML I guess I have to use the old com library MSHTML. Beacause it...
2
by: csharpers | last post by:
Hey, this is a very basic question for all you csharpers... I have created a class: public class Answer { public enum theAnswer { A, B, C } } I want to be able to do a toString as below...
0
by: BillHounslow | last post by:
hope someone can help me. Currently, I am printing four, multi-page Access 2003 Reports to MS Document Imaging, then manually combining them to form a single document for distribution. Can...
1
by: stran | last post by:
I'm trying to create a simple type that holds two different types. The first is IDREF and the second is an enumeration of string. When I generate a sample xml, I can enter any ID previously stated in...
1
by: deedeem | last post by:
Hi there, I am having trouble getting all my records to be placed into my WORD document from my ACCESS form. I have a form with a subform displayed and a control button that executes a macro. The...
7
by: chakriroxx | last post by:
hi all, i have a question related to document.execCommand(saveAs). i need to know the path of the file selected by the user in the saveAs dialog box. i need to make some changes to the saved...
0
isladogs
by: isladogs | last post by:
The next Access Europe meeting will be on Wednesday 6 Mar 2024 starting at 18:00 UK time (6PM UTC) and finishing at about 19:15 (7.15PM). In this month's session, we are pleased to welcome back...
0
by: Vimpel783 | last post by:
Hello! Guys, I found this code on the Internet, but I need to modify it a little. It works well, the problem is this: Data is sent from only one cell, in this case B5, but it is necessary that data...
0
by: jfyes | last post by:
As a hardware engineer, after seeing that CEIWEI recently released a new tool for Modbus RTU Over TCP/UDP filtering and monitoring, I actively went to its official website to take a look. It turned...
0
by: ArrayDB | last post by:
The error message I've encountered is; ERROR:root:Error generating model response: exception: access violation writing 0x0000000000005140, which seems to be indicative of an access violation...
1
by: PapaRatzi | last post by:
Hello, I am teaching myself MS Access forms design and Visual Basic. I've created a table to capture a list of Top 30 singles and forms to capture new entries. The final step is a form (unbound)...
1
by: CloudSolutions | last post by:
Introduction: For many beginners and individual users, requiring a credit card and email registration may pose a barrier when starting to use cloud servers. However, some cloud server providers now...
1
by: Defcon1945 | last post by:
I'm trying to learn Python using Pycharm but import shutil doesn't work
0
by: af34tf | last post by:
Hi Guys, I have a domain whose name is BytesLimited.com, and I want to sell it. Does anyone know about platforms that allow me to list my domain in auction for free. Thank you
0
by: Faith0G | last post by:
I am starting a new it consulting business and it's been a while since I setup a new website. Is wordpress still the best web based software for hosting a 5 page website? The webpages will be...

By using Bytes.com and it's services, you agree to our Privacy Policy and Terms of Use.

To disable or enable advertisements and analytics tracking please visit the manage ads & tracking page.