cli::commands::docwriting::AbstractCommandFormatter Class Reference

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

#include <docformatter.h>

Inheritance diagram for cli::commands::docwriting::AbstractCommandFormatter:

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

Detailed Description

Abstract base class for command documentation formatters.

Member Function Documentation

generateLongDocString()

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

pure virtual

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.

Implemented in cli::commands::docwriting::DefaultCommandFormatter.

generateShortDocString()

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

pure virtual

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.

Implemented in cli::commands::docwriting::DefaultCommandFormatter.

---

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

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