Joutsen.ArgumentsParsing v0.3.0+7-gefd96ff
Loading...
Searching...
No Matches
Public Member Functions | List of all members
Joutsen.ArgumentsParsing.DisplayHelpArgument Class Referencesealed

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.
 
- Public Member Functions inherited from Joutsen.ArgumentsParsing.AbstractDisplayArgument
 AbstractDisplayArgument (String name, String alternative, DisplayException displayException, String help)
 Creates a new instance.
 
string Usage (string name=null)
 Fetches the usage description of this argument.
 
string Description (string name=null, string alternative=null)
 Fetches the description of this argument.
 
virtual ArgumentLiteralParser GetParser ()
 Fetchs the literal parser for this argument.
 
object SetDefaultValue (object target, string name=null)
 Sets the default value of the argument to a target object.
 
virtual ParseResult Parse (ArgumentsIterator args, object target, string name=null)
 Parses the relevant argument in the list and modifies the target object with it.
 

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.
 
- 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.
 
string Name [get]
 The name that identifies the argument in the input list.
 
string Alternative [get]
 The alternative name that identifies the argument in the input list.
 
- Properties inherited from Joutsen.ArgumentsParsing.DisplayArgument
- Properties inherited from Joutsen.ArgumentsParsing.ArgumentLiteralParser

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.