HelpBuilder Class
Definition
- Namespace
- DotMake.CommandLine.Help
- Assembly
- DotMake.CommandLine.dll
Formats output to be shown to users to describe how to use a command line tool.
public class HelpBuilder- Inheritance
-
HelpBuilder
- Derived
Constructors
| HelpBuilder(int) |
Properties
| MaxWidth |
The maximum width for which to format help output. |
Methods
| CustomizeLayout(Func<HelpContext, IEnumerable<Func<HelpContext, bool>>>) |
Customizes the help sections that will be displayed. |
| CustomizeSymbol(Symbol, Func<HelpContext, string?>?, Func<HelpContext, string?>?, Func<HelpContext, string?>?) |
Specifies custom help details for a specific symbol. |
| CustomizeSymbol(Symbol, string?, string?, string?) |
Specifies custom help details for a specific symbol. |
| GetTwoColumnRow(Symbol, HelpContext) |
Gets a help item for the specified symbol. |
| Write(Command, TextWriter) |
Writes help output for the specified command. |
| Write(HelpContext) |
Writes help output for the specified command. |
| WriteColumns(IReadOnlyList<TwoColumnHelpRow>, HelpContext) |
Writes the specified help rows, aligning output in columns. |