CPP-ARGON 4.0.0
Command-Line Argument Parser for C++20
Loading...
Searching...
No Matches
argon::detail Namespace Reference

Classes

class  argument_base
 Argument class interface. More...
 
struct  argument_name
 Structure holding the argument's name. More...
 
struct  argument_token
 Structure representing a single command-line argument token. More...
 
class  help_builder
 A help message builder class. More...
 
struct  parameter_descriptor
 A structure used to represent an argument's parameter description. More...
 

Enumerations

enum class  argument_name_discriminator : bool { n_primary , n_secondary }
 Argument name member discriminator. More...
 

Functions

void add_default_argument (const default_argument arg_discriminator, argument_parser &arg_parser) noexcept
 Adds a predefined/default positional argument to the parser.
 

Enumeration Type Documentation

◆ argument_name_discriminator

Argument name member discriminator.

This discriminator type is used in the argument initializing methods of the argument_parser class.

Enumerator
n_primary 

Represents the primary name (used with a long flag prefix –).

n_secondary 

Represents the secondary name (used with a short flag prefix –).

Examples
/home/runner/work/cpp-argon/cpp-argon/include/argon/argument_parser.hpp.

Definition at line 144 of file argument_name.hpp.

Function Documentation

◆ add_default_argument()

void argon::detail::add_default_argument ( const default_argument  arg_discriminator,
argument_parser arg_parser 
)
inlinenoexcept

Adds a predefined/default positional argument to the parser.

Parameters
arg_discriminatorThe default argument discriminator.
arg_parserThe argument parser to which the argument will be added.
Examples
/home/runner/work/cpp-argon/cpp-argon/include/argon/argument_parser.hpp.

Definition at line 1588 of file argument_parser.hpp.