Joutsen.ArgumentsParsing.ArgumentsGroup Interface Reference

A group containing arguments of a simmilar kind. More...

Public Member Functions
void	AddParsersToCollection (ArgumentsListParser collection)
	Adds the literal parsers of this group's arguments to the list parser. More...
void	AddArgument (ParserArgument argument, string name=null)
	Adds a new argument to the group. More...
string	Usage ()
	Fetches the usage explanation of the arguments in the group. More...
string	Description ()
	Fetches a detailed description of the arguments in the group. More...

Properties
string	Prefix [get]
	The characters in front of the name of the arguments of this group indicating that they belong to this group. More...

Detailed Description

A group containing arguments of a simmilar kind.

Since

0.1.0

Member Function Documentation

AddArgument()

void Joutsen.ArgumentsParsing.ArgumentsGroup.AddArgument	(	ParserArgument	argument,
		string	name = null
	)

Adds a new argument to the group.

Parameters

argument	the new argument
name	if the argument is identified by its name (instead of its position) the name that identifies it

Implemented in Joutsen.ArgumentsParsing.Groups.DisplayArgumentsGroup, Joutsen.ArgumentsParsing.Groups.NamedArgumentsGroup, and Joutsen.ArgumentsParsing.Groups.PositionalArgumentsGroup.

AddParsersToCollection()

void Joutsen.ArgumentsParsing.ArgumentsGroup.AddParsersToCollection

(

ArgumentsListParser

collection

)

Adds the literal parsers of this group's arguments to the list parser.

Parameters

collection

the list parser containing all the literal parsers.

Implemented in Joutsen.ArgumentsParsing.Groups.PositionalArgumentsGroup, Joutsen.ArgumentsParsing.Groups.DefaultMutuallyExclusiveArgumentsGroup, Joutsen.ArgumentsParsing.Groups.DisplayArgumentsGroup, and Joutsen.ArgumentsParsing.Groups.NamedArgumentsGroup.

Description()

string Joutsen.ArgumentsParsing.ArgumentsGroup.Description

(

)

Fetches a detailed description of the arguments in the group.

Implemented in Joutsen.ArgumentsParsing.Groups.DisplayArgumentsGroup, Joutsen.ArgumentsParsing.Groups.NamedArgumentsGroup, Joutsen.ArgumentsParsing.Groups.PositionalArgumentsGroup, and Joutsen.ArgumentsParsing.Groups.SubParserGroup.

Usage()

string Joutsen.ArgumentsParsing.ArgumentsGroup.Usage

(

)

Fetches the usage explanation of the arguments in the group.

Implemented in Joutsen.ArgumentsParsing.Groups.DefaultMutuallyExclusiveArgumentsGroup, Joutsen.ArgumentsParsing.Groups.DisplayArgumentsGroup, Joutsen.ArgumentsParsing.Groups.NamedArgumentsGroup, Joutsen.ArgumentsParsing.Groups.PositionalArgumentsGroup, and Joutsen.ArgumentsParsing.Groups.SubParserGroup.

Property Documentation

Prefix

string Joutsen.ArgumentsParsing.ArgumentsGroup.Prefix

get

The characters in front of the name of the arguments of this group indicating that they belong to this group.

Positional groups have no prefix.

Implemented in Joutsen.ArgumentsParsing.Groups.DisplayArgumentsGroup, Joutsen.ArgumentsParsing.Groups.NamedArgumentsGroup, and Joutsen.ArgumentsParsing.Groups.PositionalArgumentsGroup.