A class for representing arguments of built-in scripts represented by BuiltInScript. More...

#include <buildincmd.h>

Public Types
enum	{ ARG_MUST = 0x1 , ARG_OPTION = 0x2 , ARG_OPTION_KEY = 0x4 }

Public Member Functions
void	parser (const std::string &option)
	Parse characters between argument name and its description and check if its an optional one.

Public Attributes
std::string	m_name
	The name of the argument.
std::string	m_desc
	A description of the argument.
uint32_t	m_flags = ARG_MUST
	Flags of the argument (basically if it's optional or not).
std::string	m_fallback_option

Detailed Description

A class for representing arguments of built-in scripts represented by BuiltInScript.

Member Enumeration Documentation

anonymous enum

void BuiltInScript::Arg::parser ( const std::string & option )

Parse characters between argument name and its description and check if its an optional one.

Parameters

[in] option The characters between argument name and its description to be parsed

std::string BuiltInScript::Arg::m_desc

A description of the argument.

std::string BuiltInScript::Arg::m_fallback_option

The argument whose value this one will fall back to if it's optional and not given explicitly

uint32_t BuiltInScript::Arg::m_flags = ARG_MUST

Flags of the argument (basically if it's optional or not).

std::string BuiltInScript::Arg::m_name

The name of the argument.

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