Class OptionSetHelp

Namespace

Pixie.Markup

Assembly

Pixie.dll

A block that renders help for a set of options grouped by category.

public sealed class OptionSetHelp : Block

Inheritance

object

MarkupElement

Block

OptionSetHelp

Inherited Members

object.GetType()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

OptionSetHelp(IReadOnlyList<Option>, OptionPrinter)

Creates help markup for a set of command-line options grouped by category.

public OptionSetHelp(IReadOnlyList<Option> options, OptionPrinter printer)

Parameters

options IReadOnlyList<Option>

The options to document.

printer OptionPrinter

The option printer to use.

Properties

Options

Gets the options being documented.

public IReadOnlyList<Option> Options { get; }

Property Value

IReadOnlyList<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 set help block to simpler markup.

public override Block Lower()

Returns

Block

The lowered block markup.