mlpack 3.4.2
program_doc.hpp
Go to the documentation of this file.
1
14#ifndef MLPACK_CORE_UTIL_PROGRAM_DOC_HPP
15#define MLPACK_CORE_UTIL_PROGRAM_DOC_HPP
16
17namespace mlpack {
18namespace util {
19
21{
22 public:
29 ProgramName(const std::string& programName);
30};
31
33{
34 public:
43 ShortDescription(const std::string& shortDescription);
44};
45
47{
48 public:
57 LongDescription(const std::function<std::string()>& longDescription);
58};
59
61{
62 public:
69 Example(const std::function<std::string()>& example);
70};
71
73{
74 public:
82 SeeAlso(const std::string& description, const std::string& link);
83};
84
85} // namespace util
86} // namespace mlpack
87
88#endif
Example(const std::function< std::string()> &example)
Construct a Example object.
LongDescription(const std::function< std::string()> &longDescription)
Construct a LongDescription object.
ProgramName(const std::string &programName)
Construct a ProgramName object.
SeeAlso(const std::string &description, const std::string &link)
Construct a SeeAlso object.
ShortDescription(const std::string &shortDescription)
Construct a ShortDescription object.
std::string programName
Linear algebra utility functions, generally performed on matrices or vectors.
Definition: cv.hpp:1