Skip to content

Class EventDocumentation

Namespace: Momentum.Extensions.EventMarkdownGenerator.Models
Assembly: Momentum.Extensions.EventMarkdownGenerator.dll

csharp
public record EventDocumentation : IEquatable<EventDocumentation>

Inheritance

objectEventDocumentation

Implements

IEquatable<EventDocumentation>

Inherited Members

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

Constructors

EventDocumentation(EventDocumentation)

csharp
protected EventDocumentation(EventDocumentation original)

Parameters

original EventDocumentation

EventDocumentation()

csharp
public EventDocumentation()

Properties

EqualityContract

csharp
protected virtual Type EqualityContract { get; }

Property Value

Type

Example

csharp
public string? Example { get; init; }

Property Value

string?

PropertyDescriptions

csharp
public Dictionary<string, string> PropertyDescriptions { get; init; }

Property Value

Dictionary<string, string>

Remarks

csharp
public string? Remarks { get; init; }

Property Value

string?

Summary

csharp
public required string Summary { get; init; }

Property Value

string

Methods

<Clone>$()

csharp
public virtual EventDocumentation <Clone>$()

Returns

EventDocumentation

Equals(object?)

csharp
public override bool Equals(object? obj)

Parameters

obj object?

Returns

bool

Equals(EventDocumentation?)

csharp
public virtual bool Equals(EventDocumentation? other)

Parameters

other EventDocumentation?

Returns

bool

GetDescription()

csharp
public string GetDescription()

Returns

string

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 ==(EventDocumentation?, EventDocumentation?)

csharp
public static bool operator ==(EventDocumentation? left, EventDocumentation? right)

Parameters

left EventDocumentation?

right EventDocumentation?

Returns

bool

operator !=(EventDocumentation?, EventDocumentation?)

csharp
public static bool operator !=(EventDocumentation? left, EventDocumentation? right)

Parameters

left EventDocumentation?

right EventDocumentation?

Returns

bool