CmdLine::Param::Definition Struct Reference

Defines a command line Param. More...

#include <Param.h>

Inheritance diagram for CmdLine::Param::Definition:

Public Attributes
std::string	name
	Gets the name of the Param.
std::string	description
	Gets the description of the Param.
bool	isMandatory = false
	Determines if the Param is mandatory.

Detailed Description

Defines a command line Param.

All classes that inherit from Param can use this struct (or a descendant of it) to construct a new Param.

Member Data Documentation

description

std::string CmdLine::Param::Definition::description

Gets the description of the Param.

The description of the parameter is used for generating HelpInfo().

Returns

The description of the parameter.

isMandatory

bool CmdLine::Param::Definition::isMandatory = false

Determines if the Param is mandatory.

See also

IsMandatory().

name

std::string CmdLine::Param::Definition::name

Gets the name of the Param.

The name of the parameter is used for generating usage and HelpInfo().

Returns

The name of the parameter.

---

The documentation for this struct was generated from the following file:

• include/Param.h