mlpack::util::ProgramDoc Class Reference

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 71 of file option.hpp.

Constructor & Destructor Documentation

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

Construct a ProgramDoc object.

When constructed, it will register itself with CLI.

Parameters

programName	Short string representing the name of the program.
documentation	Long 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

std::string mlpack::util::ProgramDoc::documentation

Documentation for what the program does.

Definition at line 89 of file option.hpp.

std::string mlpack::util::ProgramDoc::programName

The name of the program.

Definition at line 87 of file option.hpp.

---

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

• src/mlpack/core/util/option.hpp