Skip to main content

Definition

Assembly: CloudNimble.DotNetDocs.Core.dll Namespace: CloudNimble.DotNetDocs.Core Inheritance: CloudNimble.DotNetDocs.Core.DocType

Syntax

CloudNimble.DotNetDocs.Core.DocEnum

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

public DocEnum(Microsoft.CodeAnalysis.ITypeSymbol symbol)

Parameters

NameTypeDescription
symbolMicrosoft.CodeAnalysis.ITypeSymbolThe Roslyn type symbol representing the enum.

Exceptions

ExceptionDescription
ArgumentNullExceptionThrown when symbol is null.

.ctor Inherited

Inherited from CloudNimble.DotNetDocs.Core.DocType
Initializes a new instance of the DocType class.

Syntax

protected DocType()

Remarks

This parameterless constructor is provided for deserialization purposes only. Use ITypeSymbol) for normal instantiation.

.ctor Inherited

Inherited from CloudNimble.DotNetDocs.Core.DocType
Initializes a new instance of the DocType class.

Syntax

public DocType(Microsoft.CodeAnalysis.ITypeSymbol symbol)

Parameters

NameTypeDescription
symbolMicrosoft.CodeAnalysis.ITypeSymbolThe Roslyn type symbol.

Exceptions

ExceptionDescription
ArgumentNullExceptionThrown when symbol is null.

.ctor Inherited

Inherited from CloudNimble.DotNetDocs.Core.DocEntity
Initializes a new instance of the DocEntity class.

Syntax

protected DocEntity()

.ctor Inherited

Inherited from CloudNimble.DotNetDocs.Core.DocEntity
Initializes a new instance of the DocEntity class with an ISymbol.

Syntax

protected DocEntity(Microsoft.CodeAnalysis.ISymbol symbol)

Parameters

NameTypeDescription
symbolMicrosoft.CodeAnalysis.ISymbol?The symbol to store as the original reference.

.ctor Inherited

Inherited from object

Syntax

public Object()

Properties

AssemblyName Inherited

Inherited from CloudNimble.DotNetDocs.Core.DocType
Gets or sets the containing assembly name.

Syntax

public string AssemblyName { get; set; }

Property Value

Type: string? The name of the assembly containing this type.

BaseType Inherited

Inherited from CloudNimble.DotNetDocs.Core.DocType
Gets the base type name, if any.

Syntax

public string BaseType { get; set; }

Property Value

Type: string? The name of the base type, or null if none exists.

BestPractices Inherited

Inherited from CloudNimble.DotNetDocs.Core.DocEntity
Gets or sets the best practices documentation content.

Syntax

public string BestPractices { get; set; }

Property Value

Type: string? Markdown content with best practices, recommendations, and guidelines from conceptual documentation.

Considerations Inherited

Inherited from CloudNimble.DotNetDocs.Core.DocEntity
Gets or sets the considerations or notes related to the current context.

Syntax

public string Considerations { get; set; }

Property Value

Type: string? Markdown content with gotchas, performance, or security notes from conceptual documentation.

DisplayName Inherited

Inherited from CloudNimble.DotNetDocs.Core.DocEntity
Gets or sets the display name of the entity.

Syntax

public string DisplayName { get; set; }

Property Value

Type: string? The fully qualified display name extracted from the Symbol.

Examples Inherited

Inherited from CloudNimble.DotNetDocs.Core.DocEntity
Gets or sets the examples documentation content.

Syntax

public string Examples { get; set; }

Property Value

Type: string? Markdown content containing code examples from XML <example> tags.

Exceptions Inherited

Inherited from CloudNimble.DotNetDocs.Core.DocEntity
Gets or sets the collection of exceptions that can be thrown.

Syntax

public System.Collections.Generic.ICollection<CloudNimble.DotNetDocs.Core.DocException> Exceptions { get; set; }

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.DocType
Gets or sets the fully qualified name of the type.

Syntax

public string FullName { get; set; }

Property Value

Type: string? The fully qualified type name including namespace.

IncludedMembers Inherited

Inherited from CloudNimble.DotNetDocs.Core.DocEntity
Gets or sets the list of member accessibilities to include (default: Public).

Syntax

public System.Collections.Generic.List<Microsoft.CodeAnalysis.Accessibility> IncludedMembers { get; set; }

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.DocType
Gets or sets whether this type is an external reference created to host extension methods.

Syntax

public bool IsExternalReference { get; set; }

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

public bool IsFlags { get; set; }

Property Value

Type: bool True if the enum is decorated with [Flags]; otherwise, false.

Members Inherited

Inherited from CloudNimble.DotNetDocs.Core.DocType
Gets the collection of members (methods, properties, fields, events, etc.).

Syntax

public System.Collections.Generic.List<CloudNimble.DotNetDocs.Core.DocMember> Members { get; }

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.DocType
Gets or sets the name of the type.

Syntax

public string Name { get; set; }

Property Value

Type: string The type name.

OriginalSymbol Inherited

Inherited from CloudNimble.DotNetDocs.Core.DocEntity
Gets the original symbol this documentation entity was created from.

Syntax

public Microsoft.CodeAnalysis.ISymbol OriginalSymbol { get; protected set; }

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.DocEntity
Gets or sets the patterns documentation content.

Syntax

public string Patterns { get; set; }

Property Value

Type: string? Markdown content explaining common usage patterns and architectural guidance from conceptual documentation.

RelatedApis Inherited

Inherited from CloudNimble.DotNetDocs.Core.DocEntity
Gets or sets a list of related API names.

Syntax

public System.Collections.Generic.ICollection<string> RelatedApis { get; set; }

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.DocEntity
Gets or sets the remarks from XML documentation.

Syntax

public string Remarks { get; set; }

Property Value

Type: string? Content from the XML documentation’s <remarks> element.

Returns Inherited

Inherited from CloudNimble.DotNetDocs.Core.DocEntity
Gets or sets the return value documentation.

Syntax

public string Returns { get; set; }

Property Value

Type: string? Description of the return value from XML <returns> tag.

SeeAlso Inherited

Inherited from CloudNimble.DotNetDocs.Core.DocEntity
Gets or sets the collection of see-also references.

Syntax

public System.Collections.Generic.ICollection<CloudNimble.DotNetDocs.Core.DocReference> SeeAlso { get; set; }

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.DocType
Gets or sets the signature of the type.

Syntax

public string Signature { get; set; }

Property Value

Type: string? The type signature including modifiers, inheritance, etc.

Summary Inherited

Inherited from CloudNimble.DotNetDocs.Core.DocEntity
Gets or sets the summary from XML documentation.

Syntax

public string Summary { get; set; }

Property Value

Type: string? Brief description of what the API element IS, from XML <summary> tag.

Symbol Inherited

Inherited from CloudNimble.DotNetDocs.Core.DocType
Gets the Roslyn symbol for the type.

Syntax

public Microsoft.CodeAnalysis.ITypeSymbol Symbol { get; }

Property Value

Type: Microsoft.CodeAnalysis.ITypeSymbol The underlying Roslyn type symbol containing metadata.

TypeKind Inherited

Inherited from CloudNimble.DotNetDocs.Core.DocType
Gets or sets the type kind.

Syntax

public Microsoft.CodeAnalysis.TypeKind TypeKind { get; set; }

Property Value

Type: Microsoft.CodeAnalysis.TypeKind? The kind of type (Class, Interface, Struct, Enum, Delegate, etc.).

TypeParameters Inherited

Inherited from CloudNimble.DotNetDocs.Core.DocEntity
Gets or sets the collection of type parameters.

Syntax

public System.Collections.Generic.ICollection<CloudNimble.DotNetDocs.Core.DocTypeParameter> TypeParameters { get; set; }

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

public CloudNimble.DotNetDocs.Core.DocReference UnderlyingType { get; set; }

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.DocEntity
Gets or sets the usage documentation content.

Syntax

public string Usage { get; set; }

Property Value

Type: string? Markdown content explaining HOW to use the API element, from conceptual documentation.

Value Inherited

Inherited from CloudNimble.DotNetDocs.Core.DocEntity
Gets or sets the value description for properties.

Syntax

public string Value { get; set; }

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

public System.Collections.Generic.List<CloudNimble.DotNetDocs.Core.DocEnumValue> Values { get; }

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 object

Syntax

public virtual bool Equals(object obj)

Parameters

NameTypeDescription
objobject?-

Returns

Type: bool

Equals Inherited

Inherited from object

Syntax

public static bool Equals(object objA, object objB)

Parameters

NameTypeDescription
objAobject?-
objBobject?-

Returns

Type: bool

GetHashCode Inherited Virtual

Inherited from object

Syntax

public virtual int GetHashCode()

Returns

Type: int

GetType Inherited

Inherited from object

Syntax

public System.Type GetType()

Returns

Type: System.Type

MemberwiseClone Inherited

Inherited from object

Syntax

protected internal object MemberwiseClone()

Returns

Type: object

ReferenceEquals Inherited

Inherited from object

Syntax

public static bool ReferenceEquals(object objA, object objB)

Parameters

NameTypeDescription
objAobject?-
objBobject?-

Returns

Type: bool

ToJson Inherited

Inherited from CloudNimble.DotNetDocs.Core.DocEntity
Serializes this entity to JSON using consistent options.

Syntax

public string ToJson()

Returns

Type: string The JSON string representation of this entity.

ToString Inherited Virtual

Inherited from object

Syntax

public virtual string ToString()

Returns

Type: string?