API Reference

Class

HelpSyntax

Edit on GitHub

Namespace ConsoleMonster.Help

Assembly ConsoleMonster

Source HelpTopic.cs:67

Modifiers sealed

One parameter set's syntax: the command name and its parameters in order.

Inheritance

Object
HelpSyntax

Usage

Explore 21 API references to this type

This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.

Returned or exposed by 9

Extension method HelpSyntax.AddParameter
Extension method HelpSyntax.AddParameters
Extension method HelpSyntax.WithCommonParameters
Extension method HelpSyntax.WithSetName
Method HelpSyntaxFluent.AddParameter
Method HelpSyntaxFluent.AddParameters
Method HelpSyntaxFluent.WithCommonParameters
Method HelpSyntaxFluent.WithSetName
Property HelpTopic.Syntax

Accepted by parameters 12

Extension method HelpSyntax.AddParameter parameter helpSyntax
Extension method HelpSyntax.AddParameters parameter helpSyntax
Extension method HelpSyntax.WithCommonParameters parameter helpSyntax
Extension method HelpSyntax.WithSetName parameter helpSyntax
Method HelpSyntaxFluent.AddParameter parameter helpSyntax
Method HelpSyntaxFluent.AddParameters parameter helpSyntax
Method HelpSyntaxFluent.WithCommonParameters parameter helpSyntax
Method HelpSyntaxFluent.WithSetName parameter helpSyntax
Extension method HelpTopic.AddSyntax parameter item
Extension method HelpTopic.AddSyntax parameter items
Method HelpTopicFluent.AddSyntax parameter item
Method HelpTopicFluent.AddSyntax parameter items

Constructors

public HelpSyntax(String command) #

HelpTopic.cs:67

Creates a syntax line.

Parameters

command System.String requiredposition: 0: The command name.

Inherited Methods

Properties

public String Command { get; } #

HelpTopic.cs:61

The command name.

public String? SetName { get; set; } #

HelpTopic.cs:64

The parameter set's name, or null.

public IList<HelpSyntaxParameter> Parameters { get; } #

HelpTopic.cs:67

The parameters.

public Boolean CommonParameters { get; set; } #

HelpTopic.cs:70

Whether the common parameters follow.

Extension Methods

public static HelpSyntax AddParameter(HelpSyntax helpSyntax, HelpSyntaxParameter item) #

Returns: HelpSyntax

Adds an item to HelpSyntax.Parameters: The parameters.

Parameters

helpSyntax ConsoleMonster.Help.HelpSyntax requiredposition: 0: The instance.
item ConsoleMonster.Help.HelpSyntaxParameter requiredposition: 1: The item.

Returns

The same instance.

AddParameters 2 overloads

public static HelpSyntax AddParameters(HelpSyntax helpSyntax, params HelpSyntaxParameter[] items) #

Returns: HelpSyntax

Adds items to HelpSyntax.Parameters: The parameters.

Parameters

helpSyntax ConsoleMonster.Help.HelpSyntax requiredposition: 0: The instance.
items ConsoleMonster.Help.HelpSyntaxParameter[] requiredposition: 1: The items, in order.

Returns

The same instance.

public static HelpSyntax AddParameters(HelpSyntax helpSyntax, IEnumerable<HelpSyntaxParameter> items) #

Returns: HelpSyntax

Adds items to HelpSyntax.Parameters: The parameters.

Parameters

helpSyntax ConsoleMonster.Help.HelpSyntax requiredposition: 0: The instance.
items System.Collections.Generic.IEnumerable<ConsoleMonster.Help.HelpSyntaxParameter> requiredposition: 1: The items, in order.

Returns

The same instance.

public static HelpSyntax WithCommonParameters(HelpSyntax helpSyntax, Boolean value = true) #

Returns: HelpSyntax

Sets HelpSyntax.CommonParameters: Whether the common parameters follow.

Parameters

helpSyntax ConsoleMonster.Help.HelpSyntax requiredposition: 0: The instance.
value System.Boolean = true optionalposition: 1: The value (default true).

Returns

The same instance.

public static HelpSyntax WithSetName(HelpSyntax helpSyntax, String? value) #

Returns: HelpSyntax

Sets HelpSyntax.SetName: The parameter set's name, or null.

Parameters

helpSyntax ConsoleMonster.Help.HelpSyntax requiredposition: 0: The instance.
value System.String? requiredposition: 1: The value.

Returns

The same instance.