Class DefaultHelpOptionConvention

Namespace

McMaster.Extensions.CommandLineUtils.Conventions

Assembly

McMaster.Extensions.CommandLineUtils.dll

Adds a help option of --help if no other help option is specified.

public class DefaultHelpOptionConvention : IConvention

Inheritance

object

DefaultHelpOptionConvention

Implements

IConvention

Constructors

DefaultHelpOptionConvention(string)

Initializes an instance of DefaultHelpOptionConvention.

public DefaultHelpOptionConvention(string template)

Parameters

template string

Fields

DefaultHelpTemplate

The default help template.

public const string DefaultHelpTemplate = "-?|-h|--help"

Field Value

string

Methods

Apply(ConventionContext)

Apply the convention.

public void Apply(ConventionContext context)

Parameters

context ConventionContext

The context in which the convention is applied.