# ParameterExampleResult

Kind: Class  
Namespace: `Sisk.Documenting.Content`  
Assembly: `Sisk.Documenting.dll`  
Source: https://docs.sisk-framework.org/api/Sisk.Documenting.Content.ParameterExampleResult.html

Represents a parameter example used in documentation.

```csharp
public sealed class ParameterExampleResult
```

#### Inheritance

[object](https://learn.microsoft.com/dotnet/api/system.object) ← 
[ParameterExampleResult](https://docs.sisk-framework.org/api/Sisk.Documenting.Content.ParameterExampleResult.md)

#### Inherited Members

[object.GetType\(\)](https://learn.microsoft.com/dotnet/api/system.object.gettype), 
[object.ToString\(\)](https://learn.microsoft.com/dotnet/api/system.object.tostring), 
[object.Equals\(object?\)](https://learn.microsoft.com/dotnet/api/system.object.equals\#system\-object\-equals\(system\-object\)), 
[object.Equals\(object?, object?\)](https://learn.microsoft.com/dotnet/api/system.object.equals\#system\-object\-equals\(system\-object\-system\-object\)), 
[object.ReferenceEquals\(object?, object?\)](https://learn.microsoft.com/dotnet/api/system.object.referenceequals), 
[object.GetHashCode\(\)](https://learn.microsoft.com/dotnet/api/system.object.gethashcode)

## Constructors

| Name | Description |
| --- | --- |
| [ParameterExampleResult\(string, string, bool, string?\)](https://docs.sisk-framework.org/api/Sisk.Documenting.Content.ParameterExampleResult.-ctor.md#Sisk_Documenting_Content_ParameterExampleResult__ctor_System_String_System_String_System_Boolean_System_String_) | Initializes a new instance of the [ParameterExampleResult](https://docs.sisk-framework.org/api/Sisk.Documenting.Content.ParameterExampleResult.md) class with the specified parameter name, type name, requirement, and description. |
| [ParameterExampleResult\(string, string, bool\)](https://docs.sisk-framework.org/api/Sisk.Documenting.Content.ParameterExampleResult.-ctor.md#Sisk_Documenting_Content_ParameterExampleResult__ctor_System_String_System_String_System_Boolean_) | Initializes a new instance of the [ParameterExampleResult](https://docs.sisk-framework.org/api/Sisk.Documenting.Content.ParameterExampleResult.md) class with the specified parameter name, type name, and requirement. |

## Properties

| Name | Description |
| --- | --- |
| [Description](https://docs.sisk-framework.org/api/Sisk.Documenting.Content.ParameterExampleResult.Description.md#Sisk_Documenting_Content_ParameterExampleResult_Description) | Gets the description of the parameter, or [`null`](https://learn.microsoft.com/dotnet/csharp/language-reference/keywords/null) if no description is provided. |
| [IsRequired](https://docs.sisk-framework.org/api/Sisk.Documenting.Content.ParameterExampleResult.IsRequired.md#Sisk_Documenting_Content_ParameterExampleResult_IsRequired) | Gets a value indicating whether the parameter is required. |
| [ParameterName](https://docs.sisk-framework.org/api/Sisk.Documenting.Content.ParameterExampleResult.ParameterName.md#Sisk_Documenting_Content_ParameterExampleResult_ParameterName) | Gets the name of the parameter. |
| [TypeName](https://docs.sisk-framework.org/api/Sisk.Documenting.Content.ParameterExampleResult.TypeName.md#Sisk_Documenting_Content_ParameterExampleResult_TypeName) | Gets the name of the parameter's type. |