Class GeneratorOptions
Namespace: Momentum.Extensions.EventMarkdownGenerator.Models
Assembly: Momentum.Extensions.EventMarkdownGenerator.dll
public record GeneratorOptions : IEquatable<GeneratorOptions>Inheritance
Implements
Inherited Members
object.GetType(), object.MemberwiseClone(), object.ToString(), object.Equals(object?), object.Equals(object?, object?), object.ReferenceEquals(object?, object?), object.GetHashCode()
Constructors
GeneratorOptions(GeneratorOptions)
[SetsRequiredMembers]
protected GeneratorOptions(GeneratorOptions original)Parameters
original GeneratorOptions
GeneratorOptions()
public GeneratorOptions()Properties
AssemblyPaths
public List<string> AssemblyPaths { get; init; }Property Value
EmitPublicVisibility
Whether public events should render an explicit "public" visibility segment in
. Default:false (public events omit thesegment entirely, e.g. domain.subdomain.topic.v1). Internal events always render "internal" regardless of this flag, e.g. internal.domain.subdomain.topic.v1.
public bool EmitPublicVisibility { get; init; }Property Value
EqualityContract
protected virtual Type EqualityContract { get; }Property Value
EventAttributeName
Name (or name prefix) of the attribute used to discover events. Default: "EventTopicAttribute".
public string EventAttributeName { get; init; }Property Value
GitHubBaseUrl
public string? GitHubBaseUrl { get; init; }Property Value
OutputDirectory
public required string OutputDirectory { get; init; }Property Value
PartitionKeyAttributeName
Name (or name prefix) of the attribute used to discover partition keys. Default: "PartitionKeyAttribute".
public string PartitionKeyAttributeName { get; init; }Property Value
SerializationFormat
Serialization format for overhead calculation. Default: "json". Options: "json", "binary".
public string SerializationFormat { get; init; }Property Value
SidebarFileName
public required string SidebarFileName { get; init; }Property Value
SourceRootDirectory
Optional path to the source checkout root (the parent of each project's folder, e.g. the parent of src/AppDomain/). When set, an event's GitHub source link is only emitted if the guessed file actually exists under this root — otherwise it falls back to "#" rather than risk a confidently wrong link (e.g. a type declared in a file whose name doesn't match the type's own name). When unset, the link is always emitted best-effort, unverified.
public string? SourceRootDirectory { get; init; }Property Value
TemplatesDirectory
public string? TemplatesDirectory { get; init; }Property Value
XmlDocumentationPaths
public List<string> XmlDocumentationPaths { get; init; }Property Value
Methods
<Clone>$()
public virtual GeneratorOptions <Clone>$()Returns
EnsureOutputDirectoryExists()
public void EnsureOutputDirectoryExists()Equals(object?)
public override bool Equals(object? obj)Parameters
obj object?
Returns
Equals(GeneratorOptions?)
public virtual bool Equals(GeneratorOptions? other)Parameters
other GeneratorOptions?
Returns
GetHashCode()
public override int GetHashCode()Returns
GetSidebarPath()
public string GetSidebarPath()Returns
PrintMembers(StringBuilder)
protected virtual bool PrintMembers(StringBuilder builder)Parameters
builder StringBuilder
Returns
ToString()
public override string ToString()Returns
Operators
operator ==(GeneratorOptions?, GeneratorOptions?)
public static bool operator ==(GeneratorOptions? left, GeneratorOptions? right)Parameters
left GeneratorOptions?
right GeneratorOptions?
Returns
operator !=(GeneratorOptions?, GeneratorOptions?)
public static bool operator !=(GeneratorOptions? left, GeneratorOptions? right)Parameters
left GeneratorOptions?
right GeneratorOptions?