Skip to main content

Definition

Assembly: CloudNimble.DotNetDocs.Core.dll Namespace: CloudNimble.DotNetDocs.Core Inheritance: System.Object

Syntax

Summary

Base class for documentation entities, providing common contextual metadata.

Remarks

Represents shared documentation properties for assemblies, namespaces, types, members, or parameters. Now supports both XML documentation extraction and conceptual content loading with proper separation.

Examples

Constructors

.ctor Inherited

Inherited from object

Syntax

Properties

BestPractices

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

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.

DisplayName

Gets or sets the display name of the entity.

Syntax

Property Value

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

Examples

Gets or sets the examples documentation content.

Syntax

Property Value

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

Exceptions

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.

IncludedMembers

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.

OriginalSymbol

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.

Patterns

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

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

Gets or sets the remarks from XML documentation.

Syntax

Property Value

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

Returns

Gets or sets the return value documentation.

Syntax

Property Value

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

SeeAlso

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.

Summary

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.

TypeParameters

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

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

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

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?