UsageWriterWriteArgumentNameForDescription Method

Writes the name or alias of an argument for use in the argument description list.

Definition

Namespace: Ookii.CommandLine
Assembly: Ookii.CommandLine (in Ookii.CommandLine.dll) Version: 4.0.0+bb7ed9a8fdfd1cb21824750a8cf508863ad15086
C#
protected virtual void WriteArgumentNameForDescription(
	string argumentName,
	string prefix
)

Parameters

argumentName  String
The argument name or alias.
prefix  String
The argument name prefix; if using ParsingModeLongShort, this may vary depending on whether the name or alias is a short or long name or alias.

Remarks

The default implementation returns the prefix followed by the name.

This method is called by the base implementation of the WriteArgumentDescription(CommandLineArgument) method and the WriteAlias(String, String) method.

See Also