clipp::detail::token< Derived > Class Template Reference

mixin that provides basic common settings of parameters and groups More...

#include <clipp.h>

Public Types
using	doc_string = clipp::doc_string

Public Member Functions
const doc_string &	doc () const noexcept
	returns documentation string More...
Derived &	doc (const doc_string &txt)
	sets documentations string More...
Derived &	doc (doc_string &&txt)
	sets documentations string More...
bool	repeatable () const noexcept
	returns if a group/parameter is repeatable More...
Derived &	repeatable (bool yes) noexcept
	sets repeatability of group/parameter More...
bool	blocking () const noexcept
	returns if a group/parameter is blocking/positional More...
Derived &	blocking (bool yes) noexcept
	determines, if a group/parameter is blocking/positional More...

Detailed Description

template<class Derived>
class clipp::detail::token< Derived >

mixin that provides basic common settings of parameters and groups

Definition at line 1433 of file clipp.h.

Member Typedef Documentation

doc_string

template<class Derived >

using clipp::detail::token< Derived >::doc_string = clipp::doc_string

Definition at line 1437 of file clipp.h.

Member Function Documentation

blocking() [1/2]

template<class Derived >

bool clipp::detail::token< Derived >::blocking ( ) const

inlinenoexcept

returns if a group/parameter is blocking/positional

Definition at line 1474 of file clipp.h.

blocking() [2/2]

template<class Derived >

Derived& clipp::detail::token< Derived >::blocking ( bool  yes )

inlinenoexcept

determines, if a group/parameter is blocking/positional

Definition at line 1479 of file clipp.h.

doc() [1/3]

template<class Derived >

const doc_string& clipp::detail::token< Derived >::doc ( ) const

inlinenoexcept

returns documentation string

Definition at line 1442 of file clipp.h.

doc() [2/3]

template<class Derived >

Derived& clipp::detail::token< Derived >::doc ( const doc_string &  txt )

inline

sets documentations string

Definition at line 1447 of file clipp.h.

doc() [3/3]

template<class Derived >

Derived& clipp::detail::token< Derived >::doc ( doc_string &&  txt )

inline

sets documentations string

Definition at line 1453 of file clipp.h.

repeatable() [1/2]

template<class Derived >

bool clipp::detail::token< Derived >::repeatable ( ) const

inlinenoexcept

returns if a group/parameter is repeatable

Definition at line 1461 of file clipp.h.

repeatable() [2/2]

template<class Derived >

Derived& clipp::detail::token< Derived >::repeatable ( bool  yes )

inlinenoexcept

sets repeatability of group/parameter

Definition at line 1466 of file clipp.h.

---

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

• clipp.h