senf::console::ArgumentDoc Struct Reference

Documentation for a single argument. More...

#include <senf/Utils/Console/OverloadedCommand.hh>

List of all members.

---

Detailed Description

Documentation for a single argument.

This struct is used by CommandOverload::argumentDoc()

Definition at line 48 of file OverloadedCommand.hh.

Public Attributes
std::string	name
	Argument name.
std::string	type
	Argument type (string representation).
std::string	defaultValue
	Default value (string representation) or empty string.
std::string	doc
	Documentation for this argument.
bool	singleToken
	true, if argument is parsed from single token

---

Member Data Documentation

std::string senf::console::ArgumentDoc::
defaultValue

Default value (string representation) or empty string.

Definition at line 51 of file OverloadedCommand.hh.

std::string senf::console::ArgumentDoc::
doc

Documentation for this argument.

Definition at line 52 of file OverloadedCommand.hh.

std::string senf::console::ArgumentDoc::
name

Argument name.

Definition at line 49 of file OverloadedCommand.hh.

bool senf::console::ArgumentDoc::
singleToken

true, if argument is parsed from single token

Definition at line 53 of file OverloadedCommand.hh.

std::string senf::console::ArgumentDoc::
type

Argument type (string representation).

Definition at line 50 of file OverloadedCommand.hh.

---

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

• OverloadedCommand.hh