Sisk

Constructor

ParameterExampleResult constructor

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

ParameterExampleResult(string, string, bool, string?) #

Initializes a new instance of the ParameterExampleResult class with the specified parameter name, type name, requirement, and description.

C#
public ParameterExampleResult(string parameterName, string typeName, bool isRequired, string? description)

Parameters #

parameterName string

The name of the parameter.

typeName string

The name of the parameter’s type.

isRequired bool

true if the parameter is required; otherwise, false.

description string?

The description of the parameter, or null if no description is provided.

ParameterExampleResult(string, string, bool) #

Initializes a new instance of the ParameterExampleResult class with the specified parameter name, type name, and requirement.

C#
public ParameterExampleResult(string parameterName, string typeName, bool isRequired)

Parameters #

parameterName string

The name of the parameter.

typeName string

The name of the parameter’s type.

isRequired bool

true if the parameter is required; otherwise, false.

Type to search the documentation and the API reference.