Definition
Assembly: CloudNimble.DotNetDocs.Core.dll Namespace: CloudNimble.DotNetDocs.Core Inheritance: CloudNimble.DotNetDocs.Core.DocTypeSyntax
Summary
Represents documentation for a .NET enum type.Remarks
Contains metadata about an enum type and its values, extracted from Roslyn symbols and enhanced with conceptual documentation. Inherits from DocType but uses a specialized structure for enum values instead of the Members collection.Constructors
.ctor
Initializes a new instance of the DocEnum class.Syntax
Parameters
| Name | Type | Description |
|---|---|---|
symbol | Microsoft.CodeAnalysis.ITypeSymbol | The Roslyn type symbol representing the enum. |
Exceptions
| Exception | Description |
|---|---|
ArgumentNullException | Thrown when symbol is null. |
Properties
IsFlags
Gets whether this enum has the Flags attribute.Syntax
Property Value
Type:bool
True if the enum is decorated with [Flags]; otherwise, false.
UnderlyingType
Gets or sets the underlying type of the enum as a DocReference.Syntax
Property Value
Type:CloudNimble.DotNetDocs.Core.DocReference
A reference to the underlying type (e.g., System.Int32, System.Byte) that can be
resolved and linked in documentation.
Values
Gets the collection of enum values with their documentation.Syntax
Property Value
Type:System.Collections.Generic.List<CloudNimble.DotNetDocs.Core.DocEnumValue>
A list of documented enum values, each containing the name, numeric value,
and associated documentation.