Class HelpExporterBase

Namespace

ZeroInstall.Commands.Basic.Exporters

Assembly

0install.dll

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

public abstract class HelpExporterBase

Inheritance

object

HelpExporterBase

Derived

HtmlHelpExporter

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Methods

CommandDetails(string?, string, string)

protected abstract string CommandDetails(string? name, string description, string usage)

Parameters

name string

description string

usage string

Returns

string

CommandListEntry(string?, string)

protected abstract string CommandListEntry(string? name, string description)

Parameters

name string

description string

Returns

string

CommandListFooter()

protected abstract string CommandListFooter()

Returns

string

CommandListHeader()

protected abstract string CommandListHeader()

Returns

string

OptionListEntry(IEnumerable<string>, string)

protected abstract string OptionListEntry(IEnumerable<string> prototypes, string description)

Parameters

prototypes IEnumerable<string>

description string

Returns

string

OptionListFooter()

protected abstract string OptionListFooter()

Returns

string

OptionListHeader()

protected abstract string OptionListHeader()

Returns

string

ToString()

Returns all CliCommand help texts in a structured text format.

public override string ToString()

Returns

string