Momentum .NET

Appearance

Class XmlDocumentationInfo ​

Namespace: Momentum.Extensions.XmlDocs
Assembly: Momentum.Extensions.XmlDocs.dll

csharp
public class XmlDocumentationInfo

Inheritance ​

object ← XmlDocumentationInfo

Inherited Members ​

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

Constructors ​

XmlDocumentationInfo() ​

csharp
public XmlDocumentationInfo()

Properties ​

Example ​

Gets or sets example usage information.

csharp
public string? Example { get; set; }

Property Value ​

string?

Parameters ​

Gets or sets the parameter documentation keyed by parameter name.

csharp
public Dictionary<string, XmlDocumentationInfo.ParameterInfo> Parameters { get; }

Property Value ​

Dictionary<string, XmlDocumentationInfo.ParameterInfo>

Remarks ​

Gets or sets the remarks for the member. This will be added to the OpenApi description if available.

csharp
public string? Remarks { get; set; }

Property Value ​

string?

Responses ​

Gets or sets the response documentation keyed by response code.

csharp
public Dictionary<string, string?> Responses { get; }

Property Value ​

Dictionary<string, string?>

Returns ​

Gets or sets the return description for methods.

csharp
public string? Returns { get; set; }

Property Value ​

string?

Summary ​

Gets or sets the summary description of the member. This will also be used as OpenApi description

csharp
public string? Summary { get; set; }

Property Value ​

string?

Momentum .NET