mlpack  3.0.4
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
program_doc.hpp
Go to the documentation of this file.
1 
12 #ifndef MLPACK_CORE_UTIL_PROGRAM_DOC_HPP
13 #define MLPACK_CORE_UTIL_PROGRAM_DOC_HPP
14 
15 namespace mlpack {
16 namespace util {
17 
27 {
28  public:
40  ProgramDoc(const std::string& programName,
41  const std::function<std::string()>& documentation);
42 
44  std::string programName;
46  std::function<std::string()> documentation;
47 };
48 
49 } // namespace util
50 } // namespace mlpack
51 
52 #endif
std::function< std::string()> documentation
Documentation for what the program does.
Definition: program_doc.hpp:46
std::string programName
The name of the program.
Definition: program_doc.hpp:44
ProgramDoc(const std::string &programName, const std::function< std::string()> &documentation)
Construct a ProgramDoc object.
A static object whose constructor registers program documentation with the CLI class.
Definition: program_doc.hpp:26