Skip to content

Class XmlDocumentationInfo.ParameterInfo

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

csharp
public record XmlDocumentationInfo.ParameterInfo : IEquatable<XmlDocumentationInfo.ParameterInfo>

Inheritance

objectXmlDocumentationInfo.ParameterInfo

Implements

IEquatable<XmlDocumentationInfo.ParameterInfo>

Inherited Members

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

Constructors

ParameterInfo(string?, string?)

csharp
public ParameterInfo(string? Description, string? Example)

Parameters

Description string?

Example string?

ParameterInfo(ParameterInfo)

csharp
protected ParameterInfo(XmlDocumentationInfo.ParameterInfo original)

Parameters

original XmlDocumentationInfo.ParameterInfo

Properties

Description

csharp
public string? Description { get; init; }

Property Value

string?

EqualityContract

csharp
protected virtual Type EqualityContract { get; }

Property Value

Type

Example

csharp
public string? Example { get; init; }

Property Value

string?

Methods

<Clone>$()

csharp
public virtual XmlDocumentationInfo.ParameterInfo <Clone>$()

Returns

XmlDocumentationInfo.ParameterInfo

Deconstruct(out string?, out string?)

csharp
public void Deconstruct(out string? Description, out string? Example)

Parameters

Description string?

Example string?

Equals(object?)

csharp
public override bool Equals(object? obj)

Parameters

obj object?

Returns

bool

Equals(ParameterInfo?)

csharp
public virtual bool Equals(XmlDocumentationInfo.ParameterInfo? other)

Parameters

other XmlDocumentationInfo.ParameterInfo?

Returns

bool

GetHashCode()

csharp
public override int GetHashCode()

Returns

int

PrintMembers(StringBuilder)

csharp
protected virtual bool PrintMembers(StringBuilder builder)

Parameters

builder StringBuilder

Returns

bool

ToString()

csharp
public override string ToString()

Returns

string

Operators

operator ==(ParameterInfo?, ParameterInfo?)

csharp
public static bool operator ==(XmlDocumentationInfo.ParameterInfo? left, XmlDocumentationInfo.ParameterInfo? right)

Parameters

left XmlDocumentationInfo.ParameterInfo?

right XmlDocumentationInfo.ParameterInfo?

Returns

bool

operator !=(ParameterInfo?, ParameterInfo?)

csharp
public static bool operator !=(XmlDocumentationInfo.ParameterInfo? left, XmlDocumentationInfo.ParameterInfo? right)

Parameters

left XmlDocumentationInfo.ParameterInfo?

right XmlDocumentationInfo.ParameterInfo?

Returns

bool