Skip to content

Class EventWithDocumentation

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

csharp
public record EventWithDocumentation : IEquatable<EventWithDocumentation>

Inheritance

objectEventWithDocumentation

Implements

IEquatable<EventWithDocumentation>

Inherited Members

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

Constructors

EventWithDocumentation(EventWithDocumentation)

csharp
[SetsRequiredMembers]
protected EventWithDocumentation(EventWithDocumentation original)

Parameters

original EventWithDocumentation

EventWithDocumentation()

csharp
public EventWithDocumentation()

Properties

Documentation

csharp
public required EventDocumentation Documentation { get; init; }

Property Value

EventDocumentation

EqualityContract

csharp
protected virtual Type EqualityContract { get; }

Property Value

Type

Metadata

csharp
public required EventMetadata Metadata { get; init; }

Property Value

EventMetadata

Methods

<Clone>$()

csharp
public virtual EventWithDocumentation <Clone>$()

Returns

EventWithDocumentation

Equals(object?)

csharp
public override bool Equals(object? obj)

Parameters

obj object?

Returns

bool

Equals(EventWithDocumentation?)

csharp
public virtual bool Equals(EventWithDocumentation? other)

Parameters

other EventWithDocumentation?

Returns

bool

GetEventKindFolder()

The output subfolder this event's markdown belongs under: domain_events for events marked Internal on their topic attribute, integration_events otherwise. Reuses

(rather than inspecting the namespace for an

IntegrationEvents/DomainEvents segment) so placement always matches the "Domain Events" sidebar grouping already produces from the same flag. Lives here rather than on since it's a generation-pipeline output-layout decision, not a property of the event itself.

csharp
public string GetEventKindFolder()

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

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

Parameters

left EventWithDocumentation?

right EventWithDocumentation?

Returns

bool

operator !=(EventWithDocumentation?, EventWithDocumentation?)

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

Parameters

left EventWithDocumentation?

right EventWithDocumentation?

Returns

bool