UsageWriter.IncludeApplicationDescriptionBeforeCommandList Property

Gets or sets a value that indicates whether to show the application description before the command list in the usage help.

Definition

Namespace: Ookii.CommandLine
Assembly: Ookii.CommandLine (in Ookii.CommandLine.dll) Version: 4.2.0+a4d3631e4dcc0970081ed435288efdebc1325f83
C#
public bool IncludeApplicationDescriptionBeforeCommandList { get; set; }

Property Value

Boolean
true to show the description; otherwise, false. The default value is false.

Remarks

The description to show is taken from the AssemblyDescriptionAttribute of the first assembly passed to the CommandManager class. If the assembly has no description, nothing is written.

If the CommandOptions.ParentCommand property is not null, and the specified type has a DescriptionAttribute, that description is used instead.

To use a custom description, set this property to true, and override the WriteApplicationDescription(String) method.

See Also