clipp::param_filter Class Reference

filter predicate for parameters and groups; Can be used to limit documentation generation to parameter subsets. More...

#include <clipp.h>

Public Member Functions
param_filter &	prefix (const arg_string &p) noexcept
	only allow parameters with given prefix More...
param_filter &	prefix (arg_string &&p) noexcept
	only allow parameters with given prefix More...
const arg_string &	prefix () const noexcept
param_filter &	required (tri t) noexcept
	only allow parameters with given requirement status More...
tri	required () const noexcept
param_filter &	blocking (tri t) noexcept
	only allow parameters with given blocking status More...
tri	blocking () const noexcept
param_filter &	repeatable (tri t) noexcept
	only allow parameters with given repeatable status More...
tri	repeatable () const noexcept
param_filter &	has_doc (tri t) noexcept
	only allow parameters with given docstring status More...
tri	has_doc () const noexcept
bool	operator() (const parameter &p) const noexcept
	returns true, if parameter satisfies all filters More...

Detailed Description

filter predicate for parameters and groups; Can be used to limit documentation generation to parameter subsets.

Definition at line 5004 of file clipp.h.

Member Function Documentation

blocking() [1/2]

tri clipp::param_filter::blocking ( ) const

inlinenoexcept

Definition at line 5023 of file clipp.h.

blocking() [2/2]

param_filter& clipp::param_filter::blocking ( tri  t )

inlinenoexcept

only allow parameters with given blocking status

Definition at line 5022 of file clipp.h.

has_doc() [1/2]

tri clipp::param_filter::has_doc ( ) const

inlinenoexcept

Definition at line 5031 of file clipp.h.

has_doc() [2/2]

param_filter& clipp::param_filter::has_doc ( tri  t )

inlinenoexcept

only allow parameters with given docstring status

Definition at line 5030 of file clipp.h.

operator()()

bool clipp::param_filter::operator() ( const parameter &  p ) const

inlinenoexcept

returns true, if parameter satisfies all filters

Definition at line 5035 of file clipp.h.

prefix() [1/3]

const arg_string& clipp::param_filter::prefix ( ) const

inlinenoexcept

Definition at line 5015 of file clipp.h.

prefix() [2/3]

param_filter& clipp::param_filter::prefix ( arg_string &&  p )

inlinenoexcept

only allow parameters with given prefix

Definition at line 5012 of file clipp.h.

prefix() [3/3]

param_filter& clipp::param_filter::prefix ( const arg_string &  p )

inlinenoexcept

only allow parameters with given prefix

Definition at line 5008 of file clipp.h.

repeatable() [1/2]

tri clipp::param_filter::repeatable ( ) const

inlinenoexcept

Definition at line 5027 of file clipp.h.

repeatable() [2/2]

param_filter& clipp::param_filter::repeatable ( tri  t )

inlinenoexcept

only allow parameters with given repeatable status

Definition at line 5026 of file clipp.h.

required() [1/2]

tri clipp::param_filter::required ( ) const

inlinenoexcept

Definition at line 5019 of file clipp.h.

required() [2/2]

param_filter& clipp::param_filter::required ( tri  t )

inlinenoexcept

only allow parameters with given requirement status

Definition at line 5018 of file clipp.h.

---

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

• clipp.h