ReplDocOption
Option metadata.
- Kind:
Class - Namespace: Repl.Documentation
- Assembly:
Repl.Core - Source: src/Repl.Core/Documentation/ReplDocOption.cs
Signature
Section titled “Signature”public sealed record ReplDocOption : IEquatable<ReplDocOption>Inheritance
Section titled “Inheritance”Implements
Section titled “Implements”IEquatable<ReplDocOption>
Constructors
Section titled “Constructors”ReplDocOption(string, string, bool, string?, IReadOnlyList<string>, IReadOnlyList<string>, IReadOnlyList<ReplDocValueAlias>, IReadOnlyList<string>, string?)
Section titled “ReplDocOption(string, string, bool, string?, IReadOnlyList<string>, IReadOnlyList<string>, IReadOnlyList<ReplDocValueAlias>, IReadOnlyList<string>, string?)”Option metadata.
public ReplDocOption(string Name, string Type, bool Required, string? Description, IReadOnlyList<string> Aliases, IReadOnlyList<string> ReverseAliases, IReadOnlyList<ReplDocValueAlias> ValueAliases, IReadOnlyList<string> EnumValues, string? DefaultValue)Parameters
Section titled “Parameters”Name(string)Type(string)Required(bool)Description(string)Aliases(IReadOnlyList<string>)ReverseAliases(IReadOnlyList<string>)ValueAliases(IReadOnlyList<ReplDocValueAlias>)EnumValues(IReadOnlyList<string>)DefaultValue(string)
Properties
Section titled “Properties”Aliases
Section titled “Aliases”public IReadOnlyList<string> Aliases { get; init; }Returns
Section titled “Returns”IReadOnlyList<string>
DefaultValue
Section titled “DefaultValue”public string? DefaultValue { get; init; }Returns
Section titled “Returns”Description
Section titled “Description”public string? Description { get; init; }Returns
Section titled “Returns”EnumValues
Section titled “EnumValues”public IReadOnlyList<string> EnumValues { get; init; }Returns
Section titled “Returns”IReadOnlyList<string>
public string Name { get; init; }Returns
Section titled “Returns”Required
Section titled “Required”public bool Required { get; init; }Returns
Section titled “Returns”ReverseAliases
Section titled “ReverseAliases”public IReadOnlyList<string> ReverseAliases { get; init; }Returns
Section titled “Returns”IReadOnlyList<string>
public string Type { get; init; }Returns
Section titled “Returns”ValueAliases
Section titled “ValueAliases”public IReadOnlyList<ReplDocValueAlias> ValueAliases { get; init; }Returns
Section titled “Returns”IReadOnlyList<ReplDocValueAlias>