Definition
Assembly: CloudNimble.DotNetDocs.Core.dll Namespace: CloudNimble.DotNetDocs.Core Inheritance: CloudNimble.DotNetDocs.Core.DocEntitySyntax
Summary
Represents a single value within an enum type.Remarks
Inherits from DocEntity to provide standard documentation properties while adding enum-specific properties like the numeric value.Constructors
.ctor
Initializes a new instance of the DocEnumValue class.Syntax
Parameters
| Name | Type | Description |
|---|---|---|
symbol | Microsoft.CodeAnalysis.IFieldSymbol | The Roslyn field symbol representing the enum value. |
.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
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.
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.
Name
Gets or sets the name of the enum value.Syntax
Property Value
Type:string
The identifier name of the enum member.
NumericValue
Gets or sets the numeric value of the enum member.Syntax
Property Value
Type:string?
The numeric value as a string to preserve formatting (e.g., “0x10” for hex values).
May be null if the value is implicitly assigned.
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.
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
Gets the Roslyn symbol for the enum field.Syntax
Property Value
Type:Microsoft.CodeAnalysis.IFieldSymbol?
The underlying Roslyn field symbol containing metadata.
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.
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.
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?