cli::commands::docwriting::DefaultCliAppDocFormatter Class Reference

Default formatter for CLI application documentation. More...

#include <docformatter.h>

Inheritance diagram for cli::commands::docwriting::DefaultCliAppDocFormatter:

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

Detailed Description

Default formatter for CLI application documentation.

Member Function Documentation

generateAppDocString()

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

overridevirtual

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.

Implements cli::commands::docwriting::AbstractCliAppDocFormatter.

generateAppVersionString()

inline_t std::string cli::commands::docwriting::DefaultCliAppDocFormatter::generateAppVersionString ( const cli::CliConfig &  configuration )

overridevirtual

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

Parameters

configuration

The CLI configuration.

Returns

The generated version string.

Implements cli::commands::docwriting::AbstractCliAppDocFormatter.

generateCommandDocString()

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

overridevirtual

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.

Implements cli::commands::docwriting::AbstractCliAppDocFormatter.

---

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

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