API Reference
Class
HelpSyntaxFluent
The fluent methods of HelpSyntax, generated from its public properties: With... sets a property and Add... adds to a collection, both returning the same instance.
Inheritance
- Object
- HelpSyntaxFluent
Methods
public static HelpSyntax AddParameter(HelpSyntax helpSyntax, HelpSyntaxParameter item) #Returns:
HelpSyntaxAdds an item to HelpSyntax.Parameters: The parameters.
Parameters
- helpSyntax ConsoleMonster.Help.HelpSyntax
- The instance.
- item ConsoleMonster.Help.HelpSyntaxParameter
- The item.
Returns
The same instance.
AddParameters 2 overloads
public static HelpSyntax AddParameters(HelpSyntax helpSyntax, params HelpSyntaxParameter[] items) #Returns:
HelpSyntaxAdds items to HelpSyntax.Parameters: The parameters.
Parameters
- helpSyntax ConsoleMonster.Help.HelpSyntax
- The instance.
- items ConsoleMonster.Help.HelpSyntaxParameter[]
- The items, in order.
Returns
The same instance.
public static HelpSyntax AddParameters(HelpSyntax helpSyntax, IEnumerable<HelpSyntaxParameter> items) #Returns:
HelpSyntaxAdds items to HelpSyntax.Parameters: The parameters.
Parameters
- helpSyntax ConsoleMonster.Help.HelpSyntax
- The instance.
- items System.Collections.Generic.IEnumerable<ConsoleMonster.Help.HelpSyntaxParameter>
- The items, in order.
Returns
The same instance.
public static HelpSyntax WithCommonParameters(HelpSyntax helpSyntax, Boolean value = true) #Returns:
HelpSyntaxSets HelpSyntax.CommonParameters: Whether the common parameters follow.
Parameters
- helpSyntax ConsoleMonster.Help.HelpSyntax
- The instance.
- value System.Boolean = true
- The value (default true).
Returns
The same instance.
public static HelpSyntax WithSetName(HelpSyntax helpSyntax, String? value) #Returns:
HelpSyntaxSets HelpSyntax.SetName: The parameter set's name, or null.
Parameters
- helpSyntax ConsoleMonster.Help.HelpSyntax
- The instance.
- value System.String?
- The value.
Returns
The same instance.
Inherited Methods
public virtual Boolean Equals(Object? obj) #Returns:
BooleanInherited from Object
Parameters
- obj Object?