Class OptionSetSummary

Summarizes the forms of a list of options.

public sealed class OptionSetSummary : Block

Inherited Members: object.GetType()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

Creates summary markup for the forms of a set of command-line options grouped by category.

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

Gets the options being summarized.

public IReadOnlyList<Option> Options { get; }

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

public OptionPrinter Printer { get; }

Lowers this option set summary block to simpler markup.

public override Block Lower()

Sorts options by their first form and groups them by documentation category.

public static SortedDictionary<string, IReadOnlyList<Option>> SortAndGroupByCategory(IReadOnlyList<Option> options)

SortedDictionary<string, IReadOnlyList<Option>>: The options grouped by category.