An argument that displays the usage and description of a parsers arguments. More...
Public Member Functions | |
| DisplayHelpArgument (ArgumentsParser parser) | |
| Creates a new instance for a parser. More... | |
 Public Member Functions inherited from Joutsen.ArgumentsParsing.AbstractDisplayArgument | |
| AbstractDisplayArgument (String name, String alternative, DisplayException displayException, String help) | |
| Creates a new instance. More... | |
| string | Usage (string name=null) |
| Fetches the usage description of this argument. More... | |
| string | Description (string name=null, string alternative=null) |
| Fetches the description of this argument. More... | |
| virtual ArgumentLiteralParser | GetParser () |
| Fetchs the literal parser for this argument. More... | |
| object | SetDefaultValue (object target, string name=null) |
| Sets the default value of the argument to a target object. More... | |
| virtual ParseResult | Parse (ArgumentsIterator args, object target, string name=null) |
| Parses the relevant argument in the list and modifies the target object with it. More... | |
| string | Description (string name=null, string alternative=null) |
| Fetches the description of this argument. More... | |
| string | Usage (string name=null) |
| Fetches the usage description of this argument. More... | |
| ArgumentLiteralParser | GetParser () |
| Fetchs the literal parser for this argument. More... | |
| ParseResult | Parse (ArgumentsIterator args, object target, string name=null) |
| Parses the relevant argument in the list and modifies the target object with it. More... | |
| void | Reset () |
| Clears the parsers state if any in order to prepare it for a new run. More... | |
| object | SetDefaultValue (object target, string name=null) |
| Sets the default value of the argument to a target object. More... | |
Additional Inherited Members | |
| Protected Member Functions inherited from Joutsen.ArgumentsParsing.AbstractDisplayArgument | |
| virtual bool | MatchesArgument (String argument) |
| Checks if an input value matches the argument's name or alternative name. More... | |
| Protected Attributes inherited from Joutsen.ArgumentsParsing.AbstractDisplayArgument | |
| String | help |
| DisplayArgumentParser | parser |
| Properties inherited from Joutsen.ArgumentsParsing.AbstractDisplayArgument | |
| bool | IsRequired [get] |
| virtual bool | IsFlag [get] |
| Determines if this argument is nearly a flag (name only) or uses values. More... | |
| string | Name [get] |
| The name that identifies the argument in the input list. More... | |
| string | Alternative [get] |
| The alternative name that identifies the argument in the input list. More... | |
| Properties inherited from Joutsen.ArgumentsParsing.DisplayArgument | |
| String | Name [get] |
| The name that identifies the argument in the input list. More... | |
| String | Alternative [get] |
| The alternative name that identifies the argument in the input list. More... | |
| Properties inherited from Joutsen.ArgumentsParsing.ArgumentLiteralParser | |
| ArgumentsListParser | ParentParser [set] |
| The list parser this literal parser belongs to. More... | |
| bool | IsFlag [get] |
| Determines if this argument is nearly a flag (name only) or uses values. More... | |
Detailed Description
An argument that displays the usage and description of a parsers arguments.
- Since
- 0.1.0
Constructor & Destructor Documentation
◆ DisplayHelpArgument()
| Joutsen.ArgumentsParsing.DisplayHelpArgument.DisplayHelpArgument | ( | ArgumentsParser | parser | ) |
Creates a new instance for a parser.
