Sisk

Class

ParameterExampleResult

Namespace
Sisk.Documenting.Content
Assembly
Sisk.Documenting.dll

Represents a parameter example used in documentation.

C#
public sealed class ParameterExampleResult

Inheritance #

object ← ParameterExampleResult

Inherited Members #

object.GetType(), object.ToString(), object.Equals(object?), object.Equals(object?, object?), object.ReferenceEquals(object?, object?), object.GetHashCode()

Constructors #

NameDescription
ParameterExampleResult(string, string, bool, string?)Initializes a new instance of the ParameterExampleResult class with the specified parameter name, type name, requirement, and description.
ParameterExampleResult(string, string, bool)Initializes a new instance of the ParameterExampleResult class with the specified parameter name, type name, and requirement.

Properties #

NameDescription
DescriptionGets the description of the parameter, or null if no description is provided.
IsRequiredGets a value indicating whether the parameter is required.
ParameterNameGets the name of the parameter.
TypeNameGets the name of the parameter’s type.

Type to search the documentation and the API reference.