Class CommandHelpDetails

Namespace

Dassie.Extensions

Assembly

dc.dll

Represents the information displayed on a command's help page.

public class CommandHelpDetails

Inheritance

object

CommandHelpDetails

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

ObjectDump.Dump(object)

Properties

CustomSections

A list of custom help sections.

public List<(string Heading, string Text)> CustomSections { get; set; }

Property Value

List<(string Option, string Description)>

Description

A short description of the command. Most of the time, this is the same as Description.

public string Description { get; set; }

Property Value

string

Examples

A list of example invocations, along with their description.

public List<(string Command, string Description)> Examples { get; set; }

Property Value

List<(string Option, string Description)>

Options

A list of options, along with their description.

public List<(string Option, string Description)> Options { get; set; }

Property Value

List<(string Option, string Description)>

Remarks

Further, more detailed information regarding the command.

public string Remarks { get; set; }

Property Value

string

Usage

A list of usage strings for the command. Most of the time, this list has only a single entry that represents the command with all its flags and options.

public List<string> Usage { get; set; }

Property Value

List<string>