cli::commands::docwriting::DefaultCommandFormatter Class Reference

Default formatter for commands. More...

#include <docformatter.h>

Inheritance diagram for cli::commands::docwriting::DefaultCommandFormatter:

Public Member Functions
std::string	generateLongDocString (const Command &command, std::string_view fullCommandPath, const DocWriter &writer, const cli::CliConfig &configuration) override
	Generate the command documentation string.
std::string	generateShortDocString (const Command &command, std::string_view fullCommandPath, const DocWriter &writer, const cli::CliConfig &configuration) override
	Generate the short documentation string.

Detailed Description

Default formatter for commands.

Member Function Documentation

generateLongDocString()

inline_t std::string cli::commands::docwriting::DefaultCommandFormatter::generateLongDocString ( const Command &  command, std::string_view  fullCommandPath, const DocWriter &  writer, const cli::CliConfig &  configuration  )

overridevirtual

Generate the command documentation string.

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::AbstractCommandFormatter.

generateShortDocString()

inline_t std::string cli::commands::docwriting::DefaultCommandFormatter::generateShortDocString ( const Command &  command, std::string_view  fullCommandPath, const DocWriter &  writer, const cli::CliConfig &  configuration  )

overridevirtual

Generate the short documentation string.

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::AbstractCommandFormatter.

---

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

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