HelpDocument
Machine-readable help document.
- Kind:
Class - Namespace: Repl.Protocol
- Assembly:
Repl.Protocol - Source: src/Repl.Protocol/HelpDocument.cs
Signature
Section titled “Signature”public sealed record HelpDocument : IEquatable<HelpDocument>Inheritance
Section titled “Inheritance”Implements
Section titled “Implements”IEquatable<HelpDocument>
Constructors
Section titled “Constructors”HelpDocument(string, IReadOnlyList<HelpCommand>, DateTimeOffset)
Section titled “HelpDocument(string, IReadOnlyList<HelpCommand>, DateTimeOffset)”Machine-readable help document.
public HelpDocument(string Scope, IReadOnlyList<HelpCommand> Commands, DateTimeOffset GeneratedAtUtc)Parameters
Section titled “Parameters”Scope(string): Current help scope.Commands(IReadOnlyList<HelpCommand>): Discoverable commands in scope.GeneratedAtUtc(DateTimeOffset): Generation timestamp.
Properties
Section titled “Properties”Commands
Section titled “Commands”Discoverable commands in scope.
public IReadOnlyList<HelpCommand> Commands { get; init; }Returns
Section titled “Returns”IReadOnlyList<HelpCommand>
GeneratedAtUtc
Section titled “GeneratedAtUtc”Generation timestamp.
public DateTimeOffset GeneratedAtUtc { get; init; }Returns
Section titled “Returns”Current help scope.
public string Scope { get; init; }