RADLib
RADical C++ application framework
RADCLI::Option Struct Reference

One command-line option definition. More...

#include <RADCLI.h>

Public Attributes

std::string name
 Long option name without "--". More...
 
char shortName = '\0'
 Optional short option character without "-". More...
 
std::string description
 Human-readable help text. More...
 
bool requiresValue = false
 True when this option requires a value. More...
 
bool required = false
 True when this option must be provided. More...
 
std::string defaultValue
 Default value used when absent. More...
 

Detailed Description

One command-line option definition.

Member Data Documentation

◆ defaultValue

std::string RADCLI::Option::defaultValue

Default value used when absent.

◆ description

std::string RADCLI::Option::description

Human-readable help text.

◆ name

std::string RADCLI::Option::name

Long option name without "--".

◆ required

bool RADCLI::Option::required = false

True when this option must be provided.

◆ requiresValue

bool RADCLI::Option::requiresValue = false

True when this option requires a value.

◆ shortName

char RADCLI::Option::shortName = '\0'

Optional short option character without "-".


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