Option printer for man pages. More...

#include <popl.h>

Inheritance diagram for Piduino::GroffOptionPrinter:

Collaboration diagram for Piduino::GroffOptionPrinter:

Public Member Functions
	GroffOptionPrinter (const OptionParser *option_parser)
	GroffOptionPrinter implementation /////////////////////////////////.

	~GroffOptionPrinter () override=default

std::string	print (const Attribute &max_attribute=Attribute::optional) const override

Protected Attributes
const OptionParser *	option_parser_

Private Member Functions
std::string	to_string (Option_ptr option) const

Detailed Description

Option printer for man pages.

Creates help messages in groff format that can be used in man pages

Definition at line 459 of file popl.h.

Constructor & Destructor Documentation

◆ GroffOptionPrinter()

Piduino::GroffOptionPrinter::GroffOptionPrinter ( const OptionParser * option_parser )

inlineexplicit

GroffOptionPrinter implementation /////////////////////////////////.

Definition at line 1094 of file popl.h.

◆ ~GroffOptionPrinter()

Piduino::GroffOptionPrinter::~GroffOptionPrinter ( )

overridedefault

Member Function Documentation

◆ print()

std::string Piduino::GroffOptionPrinter::print ( const Attribute & max_attribute = Attribute::optional ) const

inlineoverridevirtual

Create a help message

Parameters

max_attribute show options up to this level (optional, advanced, expert)

Returns: the help message

Implements Piduino::OptionPrinter.

Definition at line 1130 of file popl.h.

References Piduino::OptionParser::description(), Piduino::hidden, Piduino::OptionPrinter::option_parser_, Piduino::optional, Piduino::OptionParser::options(), and to_string().

Here is the call graph for this function:

◆ to_string()

std::string Piduino::GroffOptionPrinter::to_string ( Option_ptr option ) const

inlineprivate

Definition at line 1098 of file popl.h.

References Piduino::optional, and Piduino::required.

Referenced by print().

Member Data Documentation

◆ option_parser_

const OptionParser* Piduino::OptionPrinter::option_parser_

protectedinherited

Definition at line 430 of file popl.h.

Referenced by Piduino::ConsoleOptionPrinter::print(), print(), and Piduino::BashCompletionOptionPrinter::print().

Public Member Functions

Protected Attributes

Private Member Functions