cli::commands::docwriting::DefaultPositionalFormatter Class Reference

Default formatter for positional arguments. More...

#include <docformatter.h>

Inheritance diagram for cli::commands::docwriting::DefaultPositionalFormatter:

Public Member Functions
std::string	generateArgDocString (const PositionalArgumentBase &argument, const cli::CliConfig &configuration) override
	Generate the argument documentation string.
std::string	generateOptionsDocString (const PositionalArgumentBase &argument, const cli::CliConfig &configuration) override
	Generate the options documentation string.

Detailed Description

Default formatter for positional arguments.

Member Function Documentation

generateArgDocString()

inline_t std::string cli::commands::docwriting::DefaultPositionalFormatter::generateArgDocString ( const PositionalArgumentBase &  argument, const cli::CliConfig &  configuration  )

overridevirtual

Generate the argument documentation string.

the argument doc string is the textual representation of the argument and its attributes

Parameters

argument	The argument to document.
configuration	The CLI configuration.

Returns

The generated documentation string.

Implements cli::commands::docwriting::AbstractArgDocFormatter< PositionalArgumentBase >.

generateOptionsDocString()

inline_t std::string cli::commands::docwriting::DefaultPositionalFormatter::generateOptionsDocString ( const PositionalArgumentBase &  argument, const cli::CliConfig &  configuration  )

overridevirtual

Generate the options documentation string.

the options doc string is used in the options section of the help message

Parameters

argument	The argument to document.
configuration	The CLI configuration.

Returns

The generated documentation string.

Implements cli::commands::docwriting::AbstractArgDocFormatter< PositionalArgumentBase >.

---

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

• src/chaincli/commands/docwriting/docformatter.h
• src/chaincli/commands/docwriting/docformatter.cpp