ChainCLI
A modern C++20 command-line interface library
Loading...
Searching...
No Matches
cli::commands::docwriting::DocsNotBuildException Class Reference

Exception thrown when documentation strings of a command are not built. More...

#include <docs_exception.h>

Inheritance diagram for cli::commands::docwriting::DocsNotBuildException:

Public Member Functions

 DocsNotBuildException (const std::string &message, const Command &command)
 Construct a DocsNotBuildException with a message and command.
 
const CommandgetCommand () const noexcept
 Gets the command whose documentation wasn't built.
 

Detailed Description

Exception thrown when documentation strings of a command are not built.

Constructor & Destructor Documentation

◆ DocsNotBuildException()

cli::commands::docwriting::DocsNotBuildException::DocsNotBuildException ( const std::string &  message,
const Command command 
)
inline

Construct a DocsNotBuildException with a message and command.

Parameters
messageThe error message
commandThe command whose docs weren't built

Member Function Documentation

◆ getCommand()

const Command & cli::commands::docwriting::DocsNotBuildException::getCommand ( ) const
inlinenoexcept

Gets the command whose documentation wasn't built.

Returns
reference to the command

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