Skip to main content

Definition

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

Syntax

Summary

Represents documentation for a .NET member (method, property, field, event, etc.).

Remarks

Contains metadata about a type member, extracted from Roslyn symbols and enhanced with conceptual documentation.

Constructors

.ctor

Initializes a new instance of the DocMember class.

Syntax

Parameters

Exceptions

.ctor Inherited

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

Syntax

.ctor Inherited

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

Syntax

Parameters

.ctor Inherited

Inherited from object

Syntax

Properties

Accessibility

Gets or sets the accessibility level of the member.

Syntax

Property Value

Type: Microsoft.CodeAnalysis.Accessibility? The accessibility level (public, private, protected, etc.).

BestPractices Inherited

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

Syntax

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

Property Value

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

DeclaringTypeName

Gets or sets the fully qualified name of the type that declares this member.

Syntax

Property Value

Type: string? For inherited members, this is the base type or interface name. For extension methods, this is the static class containing the method. For declared members, this matches the containing type.

DisplayName Inherited

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

Syntax

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

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

Property Value

Type: System.Collections.Generic.ICollection<CloudNimble.DotNetDocs.Core.DocException>? Collection of exception documentation from XML <exception> tags.

ExtendedTypeName

Gets or sets the fully qualified name of the type this extension method extends.

Syntax

Property Value

Type: string? The type of the first parameter (with this modifier), or null if not an extension method.

IncludedMembers Inherited

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

Syntax

Property Value

Type: System.Collections.Generic.List<Microsoft.CodeAnalysis.Accessibility> List of accessibility levels to include when processing child members.

IsAbstract

Gets or sets whether this member is abstract.

Syntax

Property Value

Type: bool true if the member uses the abstract keyword; otherwise false.

IsExtensionMethod

Gets or sets whether this member is an extension method.

Syntax

Property Value

Type: bool true if this is a static method with the this modifier on its first parameter; otherwise false.

IsInherited

Gets or sets whether this member is inherited from a base type or interface.

Syntax

Property Value

Type: bool true if the member is declared in a base type or interface; false if declared in the containing type.

IsOverride

Gets or sets whether this member overrides a base implementation.

Syntax

Property Value

Type: bool true if the member uses the override keyword; otherwise false.

IsVirtual

Gets or sets whether this member is virtual.

Syntax

Property Value

Type: bool true if the member uses the virtual keyword; otherwise false.

MemberKind

Gets or sets the member kind (method, property, field, event, etc.).

Syntax

Property Value

Type: Microsoft.CodeAnalysis.SymbolKind? The kind of member as defined by Roslyn.

MethodKind

Gets or sets the method kind for method members.

Syntax

Property Value

Type: System.Nullable<Microsoft.CodeAnalysis.MethodKind?>? The kind of method (Constructor, Ordinary, etc.), or null for non-method members.

Name

Gets or sets the name of the member.

Syntax

Property Value

Type: string The member name.

OriginalSymbol Inherited

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

Syntax

Property Value

Type: Microsoft.CodeAnalysis.ISymbol? The Roslyn ISymbol that was used to create this entity, preserved for reference.

OverriddenMember

Gets or sets the signature of the member being overridden, if applicable.

Syntax

Property Value

Type: string? The fully qualified signature of the base member, or null if not an override.

Parameters

Gets the collection of parameters for this member.

Syntax

Property Value

Type: System.Collections.Generic.List<CloudNimble.DotNetDocs.Core.DocParameter> List of documented parameters. Empty for members without parameters.

Remarks

This collection is populated for methods, constructors, delegates, and indexers.

Patterns Inherited

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

Syntax

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

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

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

Property Value

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

ReturnType

Gets the return type documentation, if applicable.

Syntax

Property Value

Type: CloudNimble.DotNetDocs.Core.DocType? Documentation for the return type, or null for void methods and non-method members.

ReturnTypeName

Gets or sets the name of the return type.

Syntax

Property Value

Type: string? The return type name for methods and properties, or null for other members.

SeeAlso Inherited

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

Syntax

Property Value

Type: System.Collections.Generic.ICollection<CloudNimble.DotNetDocs.Core.DocReference>? Collection of related items from XML <seealso> tags.

Signature

Gets or sets the signature of the member.

Syntax

Property Value

Type: string? The member signature including modifiers, return type, parameters, etc.

Summary Inherited

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

Syntax

Property Value

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

Symbol

Gets the Roslyn symbol for the member.

Syntax

Property Value

Type: Microsoft.CodeAnalysis.ISymbol The underlying Roslyn symbol containing metadata.

TypeParameters Inherited

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

Syntax

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

Syntax

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

Property Value

Type: string? Description of what the property represents from XML <value> tag.

Methods

Equals Inherited Virtual

Inherited from object

Syntax

Parameters

Returns

Type: bool

Equals Inherited

Inherited from object

Syntax

Parameters

Returns

Type: bool

GetHashCode Inherited Virtual

Inherited from object

Syntax

Returns

Type: int

GetType Inherited

Inherited from object

Syntax

Returns

Type: System.Type

MemberwiseClone Inherited

Inherited from object

Syntax

Returns

Type: object

ReferenceEquals Inherited

Inherited from object

Syntax

Parameters

Returns

Type: bool

ToJson Inherited

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

Syntax

Returns

Type: string The JSON string representation of this entity.

ToString Inherited Virtual

Inherited from object

Syntax

Returns

Type: string?