This project has moved and is read-only. For the latest updates, please go here.

Remarks on Enum members does not appear

Topics: Developer Forum, User Forum
Nov 28, 2008 at 2:04 PM

I am documenting some enumerations on my application as below:

Public Enum LoggingOptions As Integer
    ''' <summary>Log is not enabled.</summary>
    ''' <remarks>That is the default value for newly created applications</remarks>
    None = 0
    ''' <summary>Log is enabled.</summary>
    ''' <remarks>Determines that all actions of the application should be logged.</remarks>
    All = 1
End Enum

When I compile the help, the summaries are shown but the remarks are not. Is this by design or do I need to configure some option in order to see the remarks on the enum members.?

Nov 28, 2008 at 5:15 PM
It's by design.  The Sandcastle transformations only show the summary in the table for the enumeration members.  You'd have to modify the Sandcastle transformations to include remarks as well.  It's done via a shared template so you'd have to clone it and give it a new name so that you don't break anything else that uses the original.  However, I think most people just put all the comments within the summary since they aren't that long anyway.