Scroll to navigation

mlpack::util::ProgramDoc(3) MLPACK mlpack::util::ProgramDoc(3)

NAME

mlpack::util::ProgramDoc -
A static object whose constructor registers program documentation with the CLI class.

SYNOPSIS

Public Member Functions


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

Public Attributes


std::string documentation
 
Documentation for what the program does. std::string programName
 
The name of the program.

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/io/cli.hpp, mlpack::CLI
Definition at line 90 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 108 of file option.hpp.

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

The name of the program.
Definition at line 106 of file option.hpp.

Author

Generated automatically by Doxygen for MLPACK from the source code.
Tue Sep 9 2014 Version 1.0.10