Static method: ConsoleColoredString GenerateHelp<TArgs>(int?, Type, Func<ConsoleColoredString, ConsoleColoredString>)

• Declared in: RT.CommandLine.CommandLineParser

Declaration

public static ConsoleColoredString GenerateHelp<TArgs>(
    int? wrapWidth = null,
    Type subType = null,
    Func<ConsoleColoredString, ConsoleColoredString> helpProcessor = null
)

Summary

Generates the help screen for this command line.

Generic type parameters

TArgs

The class containing the fields and attributes which define the command-line syntax.

Parameters

int?	wrapWidth	The character width at which the output should be word-wrapped. The default (null) uses ConsoleUtil.WrapToWidth().
Type	subType	Optionally, a class that is used as a subcommand within the command-line syntax. Generates help for the subcommand.
Func<ConsoleColoredString, ConsoleColoredString>	helpProcessor	Specifies a callback which is invoked on every documentation string retrieved from the DocumentationAttributes to generate the help text. This callback can modify the text arbitrarily.