A static object whose constructor registers program documentation with the CLI class. More...

Public Member Functions

 ProgramDoc (const std::string &programName, const std::string &documentation)
 Construct a ProgramDoc object. More...

 

Public Attributes

std::string documentation
 Documentation for what the program does. More...

 
std::string programName
 The name of the program. More...

 

Detailed Description

A static object whose constructor registers program documentation with the CLI class.

This should not be used outside of CLI itself, and you should use the PROGRAM_INFO() macro to declare these objects. Only one ProgramDoc object should ever exist.

See also
core/util/cli.hpp, mlpack::CLI

Definition at line 176 of file cli_option.hpp.

Constructor & Destructor Documentation

◆ ProgramDoc()

ProgramDoc ( const std::string &  programName,
const std::string &  documentation 
)

Construct a ProgramDoc object.

When constructed, it will register itself with CLI.

Parameters
programNameShort string representing the name of the program.
documentationLong string containing documentation on how to use the program and what it is. No newline characters are necessary; this is taken care of by CLI later.

Member Data Documentation

◆ documentation

std::string documentation

Documentation for what the program does.

Definition at line 194 of file cli_option.hpp.

◆ programName

std::string programName

The name of the program.

Definition at line 192 of file cli_option.hpp.


The documentation for this class was generated from the following file:
  • /home/jenkins-mlpack/mlpack.org/_src/mlpack-3.3.2/src/mlpack/bindings/cli/cli_option.hpp