senf::console::ArgumentDoc Struct Reference

Documentation for a single argument. More...

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

Public Attributes

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

Detailed Description

Documentation for a single argument.

This struct is used by CommandOverload::argumentDoc()

Definition at line 39 of file OverloadedCommand.hh.

Member Data Documentation

◆ defaultValue

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

Default value (string representation) or empty string.

Definition at line 42 of file OverloadedCommand.hh.

◆ doc

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

Documentation for this argument.

Definition at line 43 of file OverloadedCommand.hh.

◆ name

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

Argument name.

Definition at line 40 of file OverloadedCommand.hh.

◆ singleToken

bool senf::console::ArgumentDoc::singleToken

true, if argument is parsed from single token

Definition at line 44 of file OverloadedCommand.hh.

◆ type

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

Argument type (string representation)

Definition at line 41 of file OverloadedCommand.hh.


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