Class OptionDocs

Represents documentation attached to an option.

public sealed class OptionDocs

Inherited Members: object.GetType()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

Creates documentation for an option.

public OptionDocs(string category, Block description, IReadOnlyDictionary<OptionForm, IReadOnlyList<OptionParameter>> parameters)

category string: The option's category.
description Block: A description of what the option does.
parameters IReadOnlyDictionary<OptionForm, IReadOnlyList<OptionParameter>>: A list of parameters for each option form.

Creates documentation for an option.

public OptionDocs(string category, Block description, IReadOnlyList<OptionForm> forms, IReadOnlyList<OptionParameter> parameters)

category string: The option's category.
description Block: A description of what the option does.
forms IReadOnlyList<OptionForm>: A list of forms for the option.
parameters IReadOnlyList<OptionParameter>: A common list of parameters for all option forms.

Gets the default option category.

public const string DefaultCategory = "Overall options"

Gets a description of what the option does.

public Block Description { get; }

Gets a dictionary that maps each option form to a list of parameter docs for that form.

public IReadOnlyDictionary<OptionForm, IReadOnlyList<OptionParameter>> Parameters { get; }

IReadOnlyDictionary<OptionForm, IReadOnlyList<OptionParameter>>: A list of parameters.

Gets the parameter documentation for a particular option form.

public IReadOnlyList<OptionParameter> GetParameters(OptionForm form)

IReadOnlyList<OptionParameter>: A list of parameter docs, one for each parameter.