Momentum .NET

Appearance

Class GeneratorOptions ​

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

csharp
public record GeneratorOptions : IEquatable<GeneratorOptions>

Inheritance ​

object ← GeneratorOptions

Implements ​

IEquatable<GeneratorOptions>

Inherited Members ​

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

Constructors ​

GeneratorOptions(GeneratorOptions) ​

csharp
[SetsRequiredMembers]
protected GeneratorOptions(GeneratorOptions original)

Parameters ​

original GeneratorOptions

GeneratorOptions() ​

csharp
public GeneratorOptions()

GeneratorOptions(GeneratorOptions) ​

csharp
[SetsRequiredMembers]
protected GeneratorOptions(GeneratorOptions original)

Parameters ​

original GeneratorOptions

GeneratorOptions() ​

csharp
public GeneratorOptions()

Properties ​

AssemblyPaths ​

csharp
public List<string> AssemblyPaths { get; init; }

Property Value ​

List<string>

AssemblyPaths ​

csharp
public List<string> AssemblyPaths { get; init; }

Property Value ​

List<string>

EqualityContract ​

csharp
protected virtual Type EqualityContract { get; }

Property Value ​

Type

EqualityContract ​

csharp
protected virtual Type EqualityContract { get; }

Property Value ​

Type

EventAttributeName ​

Name (or name prefix) of the attribute used to discover events. Default: "EventTopicAttribute".

csharp
public string EventAttributeName { get; init; }

Property Value ​

string

EventAttributeName ​

csharp
public string EventAttributeName { get; init; }

Property Value ​

string

GitHubBaseUrl ​

csharp
public string? GitHubBaseUrl { get; init; }

Property Value ​

string?

GitHubBaseUrl ​

csharp
public string? GitHubBaseUrl { get; init; }

Property Value ​

string?

OutputDirectory ​

csharp
public required string OutputDirectory { get; init; }

Property Value ​

string

OutputDirectory ​

csharp
public required string OutputDirectory { get; init; }

Property Value ​

string

SerializationFormat ​

Serialization format for overhead calculation. Default: "json". Options: "json", "binary".

csharp
public string SerializationFormat { get; init; }

Property Value ​

string

SerializationFormat ​

csharp
public string SerializationFormat { get; init; }

Property Value ​

string

SidebarFileName ​

csharp
public required string SidebarFileName { get; init; }

Property Value ​

string

SidebarFileName ​

csharp
public required string SidebarFileName { get; init; }

Property Value ​

string

TemplatesDirectory ​

csharp
public string? TemplatesDirectory { get; init; }

Property Value ​

string?

TemplatesDirectory ​

csharp
public string? TemplatesDirectory { get; init; }

Property Value ​

string?

XmlDocumentationPaths ​

csharp
public List<string> XmlDocumentationPaths { get; init; }

Property Value ​

List<string>

XmlDocumentationPaths ​

csharp
public List<string> XmlDocumentationPaths { get; init; }

Property Value ​

List<string>

Methods ​

<Clone>$() ​

csharp
public virtual GeneratorOptions <Clone>$()

Returns ​

GeneratorOptions

<Clone>$() ​

csharp
public virtual GeneratorOptions <Clone>$()

Returns ​

GeneratorOptions

EnsureOutputDirectoryExists() ​

csharp
public void EnsureOutputDirectoryExists()

EnsureOutputDirectoryExists() ​

csharp
public void EnsureOutputDirectoryExists()

Equals(object?) ​

csharp
public override bool Equals(object? obj)

Parameters ​

obj object?

Returns ​

bool

Equals(GeneratorOptions?) ​

csharp
public virtual bool Equals(GeneratorOptions? other)

Parameters ​

other GeneratorOptions?

Returns ​

bool

Equals(object?) ​

csharp
public override bool Equals(object? obj)

Parameters ​

obj object?

Returns ​

bool

Equals(GeneratorOptions?) ​

csharp
public virtual bool Equals(GeneratorOptions? other)

Parameters ​

other GeneratorOptions?

Returns ​

bool

GetHashCode() ​

csharp
public override int GetHashCode()

Returns ​

int

GetHashCode() ​

csharp
public override int GetHashCode()

Returns ​

int

GetSidebarPath() ​

csharp
public string GetSidebarPath()

Returns ​

string

GetSidebarPath() ​

csharp
public string GetSidebarPath()

Returns ​

string

PrintMembers(StringBuilder) ​

csharp
protected virtual bool PrintMembers(StringBuilder builder)

Parameters ​

builder StringBuilder

Returns ​

bool

PrintMembers(StringBuilder) ​

csharp
protected virtual bool PrintMembers(StringBuilder builder)

Parameters ​

builder StringBuilder

Returns ​

bool

ToString() ​

csharp
public override string ToString()

Returns ​

string

ToString() ​

csharp
public override string ToString()

Returns ​

string

Operators ​

operator ==(GeneratorOptions?, GeneratorOptions?) ​

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

Parameters ​

left GeneratorOptions?

right GeneratorOptions?

Returns ​

bool

operator ==(GeneratorOptions?, GeneratorOptions?) ​

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

Parameters ​

left GeneratorOptions?

right GeneratorOptions?

Returns ​

bool

operator !=(GeneratorOptions?, GeneratorOptions?) ​

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

Parameters ​

left GeneratorOptions?

right GeneratorOptions?

Returns ​

bool

operator !=(GeneratorOptions?, GeneratorOptions?) ​

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

Parameters ​

left GeneratorOptions?

right GeneratorOptions?

Returns ​

bool

Momentum .NET