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. |
.ctor Inherited
Inherited from
CloudNimble.DotNetDocs.Core.DocTypeSyntax
Remarks
This parameterless constructor is provided for deserialization purposes only. UseITypeSymbol) for normal instantiation.
.ctor Inherited
Inherited from
CloudNimble.DotNetDocs.Core.DocTypeSyntax
Parameters
| Name | Type | Description |
|---|---|---|
symbol | Microsoft.CodeAnalysis.ITypeSymbol | The Roslyn type symbol. |
Exceptions
| Exception | Description |
|---|---|
ArgumentNullException | Thrown when symbol is null. |
.ctor Inherited
Inherited from
CloudNimble.DotNetDocs.Core.DocEntitySyntax
.ctor Inherited
Inherited from
CloudNimble.DotNetDocs.Core.DocEntitySyntax
Parameters
| Name | Type | Description |
|---|---|---|
symbol | Microsoft.CodeAnalysis.ISymbol? | The symbol to store as the original reference. |
.ctor Inherited
Inherited from
objectSyntax
Properties
AssemblyName Inherited
Inherited from
CloudNimble.DotNetDocs.Core.DocTypeSyntax
Property Value
Type:string?
The name of the assembly containing this type.
BaseType Inherited
Inherited from
CloudNimble.DotNetDocs.Core.DocTypeSyntax
Property Value
Type:string?
The name of the base type, or null if none exists.
BestPractices Inherited
Inherited from
CloudNimble.DotNetDocs.Core.DocEntitySyntax
Property Value
Type:string?
Markdown content with best practices, recommendations, and guidelines from conceptual documentation.
Considerations Inherited
Inherited from
CloudNimble.DotNetDocs.Core.DocEntitySyntax
Property Value
Type:string?
Markdown content with gotchas, performance, or security notes from conceptual documentation.
DisplayName Inherited
Inherited from
CloudNimble.DotNetDocs.Core.DocEntitySyntax
Property Value
Type:string?
The fully qualified display name extracted from the Symbol.
Examples Inherited
Inherited from
CloudNimble.DotNetDocs.Core.DocEntitySyntax
Property Value
Type:string?
Markdown content containing code examples from XML <example> tags.
Exceptions Inherited
Inherited from
CloudNimble.DotNetDocs.Core.DocEntitySyntax
Property Value
Type:System.Collections.Generic.ICollection<CloudNimble.DotNetDocs.Core.DocException>?
Collection of exception documentation from XML <exception> tags.
FullName Inherited
Inherited from
CloudNimble.DotNetDocs.Core.DocTypeSyntax
Property Value
Type:string?
The fully qualified type name including namespace.
IncludedMembers Inherited
Inherited from
CloudNimble.DotNetDocs.Core.DocEntitySyntax
Property Value
Type:System.Collections.Generic.List<Microsoft.CodeAnalysis.Accessibility>
List of accessibility levels to include when processing child members.
IsExternalReference Inherited
Inherited from
CloudNimble.DotNetDocs.Core.DocTypeSyntax
Property Value
Type:bool
true if this type is not part of the documented assembly but was created
to show extension methods that apply to it; otherwise false.
Remarks
External references are minimal DocType instances created when extension methods target types outside the current assembly. These types link to official documentation rather than duplicating external API documentation.IsFlags
Gets whether this enum has the Flags attribute.Syntax
Property Value
Type:bool
True if the enum is decorated with [Flags]; otherwise, false.
Members Inherited
Inherited from
CloudNimble.DotNetDocs.Core.DocTypeSyntax
Property Value
Type:System.Collections.Generic.List<CloudNimble.DotNetDocs.Core.DocMember>
List of documented members within this type.
Name Inherited
Inherited from
CloudNimble.DotNetDocs.Core.DocTypeSyntax
Property Value
Type:string
The type name.
OriginalSymbol Inherited
Inherited from
CloudNimble.DotNetDocs.Core.DocEntitySyntax
Property Value
Type:Microsoft.CodeAnalysis.ISymbol?
The Roslyn ISymbol that was used to create this entity, preserved for reference.
Patterns Inherited
Inherited from
CloudNimble.DotNetDocs.Core.DocEntitySyntax
Property Value
Type:string?
Markdown content explaining common usage patterns and architectural guidance from conceptual documentation.
RelatedApis Inherited
Inherited from
CloudNimble.DotNetDocs.Core.DocEntitySyntax
Property Value
Type:System.Collections.Generic.ICollection<string>?
List of fully qualified names or URLs for related APIs from conceptual documentation.
Remarks Inherited
Inherited from
CloudNimble.DotNetDocs.Core.DocEntitySyntax
Property Value
Type:string?
Content from the XML documentation’s <remarks> element.
Returns Inherited
Inherited from
CloudNimble.DotNetDocs.Core.DocEntitySyntax
Property Value
Type:string?
Description of the return value from XML <returns> tag.
SeeAlso Inherited
Inherited from
CloudNimble.DotNetDocs.Core.DocEntitySyntax
Property Value
Type:System.Collections.Generic.ICollection<CloudNimble.DotNetDocs.Core.DocReference>?
Collection of related items from XML <seealso> tags.
Signature Inherited
Inherited from
CloudNimble.DotNetDocs.Core.DocTypeSyntax
Property Value
Type:string?
The type signature including modifiers, inheritance, etc.
Summary Inherited
Inherited from
CloudNimble.DotNetDocs.Core.DocEntitySyntax
Property Value
Type:string?
Brief description of what the API element IS, from XML <summary> tag.
Symbol Inherited
Inherited from
CloudNimble.DotNetDocs.Core.DocTypeSyntax
Property Value
Type:Microsoft.CodeAnalysis.ITypeSymbol
The underlying Roslyn type symbol containing metadata.
TypeKind Inherited
Inherited from
CloudNimble.DotNetDocs.Core.DocTypeSyntax
Property Value
Type:Microsoft.CodeAnalysis.TypeKind?
The kind of type (Class, Interface, Struct, Enum, Delegate, etc.).
TypeParameters Inherited
Inherited from
CloudNimble.DotNetDocs.Core.DocEntitySyntax
Property Value
Type:System.Collections.Generic.ICollection<CloudNimble.DotNetDocs.Core.DocTypeParameter>?
Collection of type parameter documentation from XML <typeparam> tags.
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.
Usage Inherited
Inherited from
CloudNimble.DotNetDocs.Core.DocEntitySyntax
Property Value
Type:string?
Markdown content explaining HOW to use the API element, from conceptual documentation.
Value Inherited
Inherited from
CloudNimble.DotNetDocs.Core.DocEntitySyntax
Property Value
Type:string?
Description of what the property represents from XML <value> tag.
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.
Methods
Equals Inherited Virtual
Inherited from
objectSyntax
Parameters
| Name | Type | Description |
|---|---|---|
obj | object? | - |
Returns
Type:bool
Equals Inherited
Inherited from
objectSyntax
Parameters
| Name | Type | Description |
|---|---|---|
objA | object? | - |
objB | object? | - |
Returns
Type:bool
GetHashCode Inherited Virtual
Inherited from
objectSyntax
Returns
Type:int
GetType Inherited
Inherited from
objectSyntax
Returns
Type:System.Type
MemberwiseClone Inherited
Inherited from
objectSyntax
Returns
Type:object
ReferenceEquals Inherited
Inherited from
objectSyntax
Parameters
| Name | Type | Description |
|---|---|---|
objA | object? | - |
objB | object? | - |
Returns
Type:bool
ToJson Inherited
Inherited from
CloudNimble.DotNetDocs.Core.DocEntitySyntax
Returns
Type:string
The JSON string representation of this entity.
ToString Inherited Virtual
Inherited from
objectSyntax
Returns
Type:string?