UsageWriterWriteParserUsageCore Method

Creates the usage help for a CommandLineParser instance.

Definition

Namespace: Ookii.CommandLine
Assembly: Ookii.CommandLine (in Ookii.CommandLine.dll) Version: 4.2.0+a4d3631e4dcc0970081ed435288efdebc1325f83
C#
protected virtual void WriteParserUsageCore(
	UsageHelpRequest request
)

Parameters

request  UsageHelpRequest
The parts of usage to write.

Remarks

This is the primary method used to generate usage help for the CommandLineParser class. It calls into the various other methods of this class, so overriding this method should not typically be necessary unless you wish to deviate from the order in which usage elements are written.

The base implementation writes the application description, followed by the usage syntax, followed by the class validator help messages, followed by a list of argument descriptions. Which elements are included exactly can be influenced by the request parameter and the properties of this class.

See Also