JASSv2
Public Member Functions | Public Attributes | List of all members
JASS::commandline::command< TYPE > Class Template Reference

A single command line parameter. More...

Public Member Functions

 command (const std::string &shortname, const std::string &longname, const std::string &description, TYPE &parameter)
 Build an object that represents a possible command line parameter. More...
 

Public Attributes

std::string shortname
 The short name to match e.g. "-m".
 
std::string longname
 The long name to mathc e.g. "-mood".
 
std::string description
 The descriptrion to show when the user asks for help e.g. "The users' mood".
 
TYPE & parameter
 A reference to the external variable to set based on the command line.
 

Detailed Description

template<typename TYPE>
class JASS::commandline::command< TYPE >

A single command line parameter.

Constructor & Destructor Documentation

◆ command()

template<typename TYPE>
JASS::commandline::command< TYPE >::command ( const std::string &  shortname,
const std::string &  longname,
const std::string &  description,
TYPE &  parameter 
)
inline

Build an object that represents a possible command line parameter.

Parameters
shortname[in] The short name to match e.g. "-m".
longname[in] The long name to mathc e.g. "-mood".
description[in] The descriptrion to show when the user asks for help e.g. "The users' mood".
parameter[out] A reference to the external variable to set based on the command line.

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