Definition
Assembly: CloudNimble.DotNetDocs.Core.dll Namespace: CloudNimble.DotNetDocs.Core Inheritance: CloudNimble.DotNetDocs.Core.DocEntitySyntax
Summary
Represents documentation for a method or constructor parameter.Remarks
Contains metadata about a parameter, extracted from Roslyn symbols and enhanced with conceptual documentation.Constructors
.ctor
Initializes a new instance of the DocParameter class.Syntax
Parameters
| Name | Type | Description |
|---|---|---|
symbol | Microsoft.CodeAnalysis.IParameterSymbol | The Roslyn parameter symbol. |
Exceptions
| Exception | Description |
|---|---|
ArgumentNullException | Thrown when symbol is null. |
.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.
DefaultValue
Gets the default value of the parameter, if any.Syntax
Property Value
Type:string?
The default value as a string, or null if no default value exists.
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.
HasDefaultValue
Gets or sets a value indicating whether this parameter has a default value.Syntax
Property Value
Type:bool
True if the parameter has a default value; otherwise, false.
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.
IsOptional
Gets or sets a value indicating whether this parameter is optional.Syntax
Property Value
Type:bool
True if the parameter is optional; otherwise, false.
IsParams
Gets or sets a value indicating whether this parameter uses the params keyword.Syntax
Property Value
Type:bool
True if the parameter is a params array; otherwise, false.
Name
Gets or sets the name of the parameter.Syntax
Property Value
Type:string
The parameter name.
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.
ParameterType
Gets the parameter type documentation.Syntax
Property Value
Type:CloudNimble.DotNetDocs.Core.DocType?
Documentation for the parameter’s type.
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 parameter.Syntax
Property Value
Type:Microsoft.CodeAnalysis.IParameterSymbol
The underlying Roslyn parameter symbol containing metadata.
TypeName
Gets or sets the type name of the parameter.Syntax
Property Value
Type:string?
The fully qualified type name of the parameter.
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?