Definition
Assembly: CloudNimble.DotNetDocs.Core.dll Namespace: CloudNimble.DotNetDocs.Core Inheritance: CloudNimble.DotNetDocs.Core.DocEntitySyntax
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
| Name | Type | Description |
|---|---|---|
symbol | Microsoft.CodeAnalysis.ISymbol | The Roslyn member symbol. |
Exceptions
| Exception | Description |
|---|---|
ArgumentNullException | Thrown when symbol is null. |
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.).
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.
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.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.
Signature
Gets or sets the signature of the member.Syntax
Property Value
Type:string?
The member signature including modifiers, return type, parameters, etc.
Symbol
Gets the Roslyn symbol for the member.Syntax
Property Value
Type:Microsoft.CodeAnalysis.ISymbol
The underlying Roslyn symbol containing metadata.