ChainCLI
A modern C++20 command-line interface library
Loading...
Searching...
No Matches
Public Member Functions | List of all members
cli::commands::docwriting::AbstractArgDocFormatter< T > Class Template Referenceabstract

Abstract base class for argument documentation formatters. More...

#include <docformatter.h>

Public Member Functions

virtual std::string generateArgDocString (const T &argument, const cli::CliConfig &configuration)=0
 Generate the argument documentation string.
 
virtual std::string generateOptionsDocString (const T &argument, const cli::CliConfig &configuration)=0
 Generate the options documentation string.
 

Detailed Description

template<typename T>
class cli::commands::docwriting::AbstractArgDocFormatter< T >

Abstract base class for argument documentation formatters.

Template Parameters
TThe type of argument to format.

Member Function Documentation

◆ generateArgDocString()

template<typename T >
virtual std::string cli::commands::docwriting::AbstractArgDocFormatter< T >::generateArgDocString ( const T &  argument,
const cli::CliConfig &  configuration 
)
pure virtual

Generate the argument documentation string.

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

Parameters
argumentThe argument to document.
configurationThe CLI configuration.
Returns
The generated documentation string.

Implemented in cli::commands::docwriting::DefaultFlagFormatter, cli::commands::docwriting::DefaultOptionFormatter, and cli::commands::docwriting::DefaultPositionalFormatter.

◆ generateOptionsDocString()

template<typename T >
virtual std::string cli::commands::docwriting::AbstractArgDocFormatter< T >::generateOptionsDocString ( const T &  argument,
const cli::CliConfig &  configuration 
)
pure virtual

Generate the options documentation string.

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

Parameters
argumentThe argument to document.
configurationThe CLI configuration.
Returns
The generated documentation string.

Implemented in cli::commands::docwriting::DefaultFlagFormatter, cli::commands::docwriting::DefaultOptionFormatter, and cli::commands::docwriting::DefaultPositionalFormatter.

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