Class OptionHelp

Namespace

Pixie.Markup

Assembly

Pixie.dll

A block that renders a short manual for one option.

public sealed class OptionHelp : Block

Inheritance

object

MarkupElement

Block

OptionHelp

Inherited Members

object.GetType()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

OptionHelp(Option, OptionPrinter)

Creates help markup for one command-line option.

public OptionHelp(Option option, OptionPrinter printer)

Parameters

option Option

The option to document.

printer OptionPrinter

The option printer to use.

Properties

Option

Gets the option being documented.

public Option Option { get; }

Property Value

Option

Printer

Gets the option printer used to render option names and arguments.

public OptionPrinter Printer { get; }

Property Value

OptionPrinter

Methods

Lower()

Lowers this option help block to simpler markup.

public override Block Lower()

Returns

Block

The lowered block markup.