C# Class ZeroInstall.Commands.Utils.HelpExporterBase

Common base class for exporting all CliCommand help texts in a structured text format.

Mostra file Open project: 0install/0install-win

Public Methods

Method	Description
ToString ( ) : string	Returns all CliCommand help texts in a structured text format.

Protected Methods

Method	Description
CommandDetails ( string name, string description, string usage ) : string
CommandListEntry ( string name, string description ) : string
CommandListFooter ( ) : string
CommandListHeader ( ) : string
OptionListEntry ( IEnumerable prototypes, string description ) : string
OptionListFooter ( ) : string
OptionListHeader ( ) : string

Private Methods

Method	Description
ForEachCommand ( Action action ) : void
GetPrototypes ( NDesk.Options.Option option ) : IEnumerable

Method Details

CommandDetails() protected abstract method

protected abstract CommandDetails ( string name, string description, string usage ) : string
name	string
description	string
usage	string
return	string

CommandListEntry() protected abstract method

protected abstract CommandListEntry ( string name, string description ) : string
name	string
description	string
return	string

CommandListFooter() protected abstract method

protected abstract CommandListFooter ( ) : string
return	string

CommandListHeader() protected abstract method

protected abstract CommandListHeader ( ) : string
return	string

OptionListEntry() protected abstract method

protected abstract OptionListEntry ( IEnumerable prototypes, string description ) : string
prototypes	IEnumerable
description	string
return	string

OptionListFooter() protected abstract method

protected abstract OptionListFooter ( ) : string
return	string

OptionListHeader() protected abstract method

protected abstract OptionListHeader ( ) : string
return	string

ToString() public method

Returns all CliCommand help texts in a structured text format.

public ToString ( ) : string
return	string