clara::detail::Help Struct Reference

#include <clara.hpp>

Inheritance diagram for clara::detail::Help:

Collaboration diagram for clara::detail::Help:

Public Member Functions
	Help (bool &showHelpFlag)
Public Member Functions inherited from clara::detail::Opt
template<typename LambdaT >
	Opt (LambdaT const &ref)
	Opt (bool &ref)
template<typename LambdaT >
	Opt (LambdaT const &ref, std::string const &hint)
template<typename T >
	Opt (T &ref, std::string const &hint)
auto	operator[] (std::string const &optName) -> Opt &
auto	getHelpColumns () const -> std::vector< HelpColumns >
auto	isMatch (std::string const &optToken) const -> bool
auto	parse (std::string const &, TokenStream const &tokens) const -> InternalParseResult override
auto	validate () const -> Result override
auto	parse (Args const &args) const -> InternalParseResult
Public Member Functions inherited from clara::detail::ParserRefImpl< Opt >
	ParserRefImpl (T &ref, std::string const &hint)
	ParserRefImpl (LambdaT const &ref, std::string const &hint)
auto	operator() (std::string const &description) -> Opt &
auto	optional () -> Opt &
auto	required () -> Opt &
auto	isOptional () const -> bool
auto	cardinality () const -> size_t override
auto	hint () const -> std::string
Public Member Functions inherited from clara::detail::ComposableParserImpl< Opt >
auto	operator| (T const &other) const -> Parser
auto	operator+ (T const &other) const -> Parser
Public Member Functions inherited from clara::detail::ParserBase
virtual	~ParserBase ()=default
auto	parse (Args const &args) const -> InternalParseResult

Additional Inherited Members
Protected Member Functions inherited from clara::detail::ParserRefImpl< Opt >
	ParserRefImpl (std::shared_ptr< BoundRef > const &ref)
Protected Attributes inherited from clara::detail::Opt
std::vector< std::string >	m_optNames
Protected Attributes inherited from clara::detail::ParserRefImpl< Opt >
Optionality	m_optionality
std::shared_ptr< BoundRef >	m_ref
std::string	m_hint
std::string	m_description

Detailed Description

Definition at line 1061 of file clara.hpp.

Constructor & Destructor Documentation

Help()

clara::detail::Help::Help ( bool & showHelpFlag )

inline

Definition at line 1062 of file clara.hpp.

        :   Opt([&]( bool flag ) {
                showHelpFlag = flag;
                return ParserResult::ok( ParseResultType::ShortCircuitAll );
            })
        {
            static_cast<Opt &>( *this )
                    ("display usage information")
                    ["-?"]["-h"]["--help"]
                    .optional();
        }

Here is the call graph for this function:

---

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

• libraries/sys-vm/external/Catch2/third_party/clara.hpp