HelpBuilder.CustomizeSymbol Method

Definition

Namespace

DotMake.CommandLine.Help

Assembly

DotMake.CommandLine.dll

CustomizeSymbol(Symbol, Func<HelpContext, string?>?, Func<HelpContext, string?>?, Func<HelpContext, string?>?)

Specifies custom help details for a specific symbol.

public void CustomizeSymbol(Symbol symbol, Func<HelpContext, string?>? firstColumnText = null, Func<HelpContext, string?>? secondColumnText = null, Func<HelpContext, string?>? defaultValue = null)

Parameters

symbol Symbol

The symbol to specify custom help details for.

firstColumnText Func<HelpContext, string>

A delegate to display the first help column (typically name and usage information).

secondColumnText Func<HelpContext, string>

A delegate to display second help column (typically the description).

defaultValue Func<HelpContext, string>

A delegate to display the default value for the symbol.

CustomizeSymbol(Symbol, string?, string?, string?)

Specifies custom help details for a specific symbol.

public void CustomizeSymbol(Symbol symbol, string? firstColumnText = null, string? secondColumnText = null, string? defaultValue = null)

Parameters

symbol Symbol

The symbol to customize the help details for.

firstColumnText string

A delegate to display the first help column (typically name and usage information).

secondColumnText string

A delegate to display second help column (typically the description).

defaultValue string

The displayed default value for the symbol.