Joutsen.ArgumentsParsing.ParserArgument Interface Reference

A single argument of the parser. More...

Public Member Functions
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...

Detailed Description

A single argument of the parser.

Since

0.1.0

Member Function Documentation

Description()

string Joutsen.ArgumentsParsing.ParserArgument.Description	(	string	name = null,
		string	alternative = null
	)

Fetches the description of this argument.

Parameters

name	for arguments that are identified by their name in the input string, the name to incorporate into the description
alternative	for arguments that are identified by their alternative name in the input string, the alternative name to incorporate into the description

Returns

the description

Implemented in Joutsen.ArgumentsParsing.ValueArgument< ValueType >, Joutsen.ArgumentsParsing.Parsers.DefaultSubParser< TResultType >, Joutsen.ArgumentsParsing.TargetPropertyArgument< ValueType >, Joutsen.ArgumentsParsing.AbstractDisplayArgument, and Joutsen.ArgumentsParsing.ChoiceArgument< ValueType >.

GetParser()

ArgumentLiteralParser Joutsen.ArgumentsParsing.ParserArgument.GetParser

(

)

Fetchs the literal parser for this argument.

Implemented in Joutsen.ArgumentsParsing.TargetPropertyArgument< ValueType >, and Joutsen.ArgumentsParsing.AbstractDisplayArgument.

Usage()

string Joutsen.ArgumentsParsing.ParserArgument.Usage

(

string

name = null

)

Fetches the usage description of this argument.

Parameters

name	for arguments that are identified by their name in the input string, the name to incorporate into the description

Returns

the usage description

Implemented in Joutsen.ArgumentsParsing.Parsers.DefaultSubParser< TResultType >, Joutsen.ArgumentsParsing.ValueArgument< ValueType >, Joutsen.ArgumentsParsing.TargetPropertyArgument< ValueType >, and Joutsen.ArgumentsParsing.AbstractDisplayArgument.