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::function< std::string()> &documentation)
	Construct a ProgramDoc object. More...

Public Attributes
std::function< 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 26 of file program_doc.hpp.

Constructor & Destructor Documentation

ProgramDoc	(	const std::string &	programName,
		const std::function< std::string()> &	documentation
	)

Construct a ProgramDoc object.

When constructed, it will register itself with CLI, and when the user calls –help (or whatever the option is named for the given binding type), the given function that returns a std::string will be returned.

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::function<std::string()> documentation

Documentation for what the program does.

Definition at line 46 of file program_doc.hpp.

std::string programName

The name of the program.

Definition at line 44 of file program_doc.hpp.

---

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

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