HelpBuilder.Default Class
Definition
- Namespace
- DotMake.CommandLine.Help
- Assembly
- DotMake.CommandLine.dll
Provides default formatting for help output.
public static class HelpBuilder.Default- Inheritance
-
HelpBuilder.Default
Methods
| AdditionalArgumentsSection() |
Writes a help section describing a command's additional arguments, typically shown only when TreatUnmatchedTokensAsErrors is set to true. |
| CommandArgumentsSection() |
Writes a help section describing a command's arguments. |
| CommandUsageSection() |
Writes a help section describing a command's usage. |
| GetArgumentDefaultValue(Symbol) |
Gets an argument's default value to be displayed in help. |
| GetArgumentDescription(Argument) |
Gets the description for an argument (typically used in the second column text in the arguments section). |
| GetArgumentUsageLabel(Symbol) |
Gets the usage title for an argument (for example: |
| GetCommandUsageLabel(Command) |
Gets the usage label for the specified symbol (typically used as the first column text in help output). |
| GetLayout() |
Gets the default sections to be written for command line help. |
| GetOptionUsageLabel(Option) |
Gets the usage label for the specified symbol (typically used as the first column text in help output). |
| OptionsSection() |
Writes a help section describing a command's options. |
| SubcommandsSection() |
Writes a help section describing a command's subcommands. |
| SynopsisSection() |
Writes a help section describing a command's synopsis. |