cli::commands::docwriting::AbstractCliAppDocFormatter Class Reference

Abstract base class for CLI application documentation formatters. More...

#include <docformatter.h>

Inheritance diagram for cli::commands::docwriting::AbstractCliAppDocFormatter:

Public Member Functions
virtual std::string	generateAppDocString (const cli::CliConfig &configuration, const std::vector< const cli::commands::Command * > &commands)=0
	Generate the application documentation string that shows all the available commands.
virtual std::string	generateAppVersionString (const cli::CliConfig &configuration)=0
	Generate the application version string that is shown with the –version flag.
virtual std::string	generateCommandDocString (const Command &command, const cli::CliConfig &configuration)=0
	Generate the documentation string for a specific command.

Detailed Description

Abstract base class for CLI application documentation formatters.

Member Function Documentation

generateAppDocString()

virtual std::string cli::commands::docwriting::AbstractCliAppDocFormatter::generateAppDocString ( const cli::CliConfig &  configuration, const std::vector< const cli::commands::Command * > &  commands  )

pure virtual

Generate the application documentation string that shows all the available commands.

Parameters

writer	The documentation writer.
configuration	The CLI configuration.
commands	The list of commands to document.

Returns

The generated documentation string.

Implemented in cli::commands::docwriting::DefaultCliAppDocFormatter.

generateAppVersionString()

virtual std::string cli::commands::docwriting::AbstractCliAppDocFormatter::generateAppVersionString ( const cli::CliConfig &  configuration )

pure virtual

Generate the application version string that is shown with the –version flag.

Parameters

configuration

The CLI configuration.

Returns

The generated version string.

Implemented in cli::commands::docwriting::DefaultCliAppDocFormatter.

generateCommandDocString()

virtual std::string cli::commands::docwriting::AbstractCliAppDocFormatter::generateCommandDocString ( const Command &  command, const cli::CliConfig &  configuration  )

pure virtual

Generate the documentation string for a specific command.

Parameters

command	The command to document.
fullCommandPath	The full path of the command.
writer	The documentation writer.
configuration	The CLI configuration.

Returns

The generated documentation string.

Implemented in cli::commands::docwriting::DefaultCliAppDocFormatter.

---

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

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