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 
17 namespace mlpack {
18 namespace util {
19 
21 {
22  public:
31  BindingName(const std::string& bindingName, const std::string& name);
32 };
33 
35 {
36  public:
46  ShortDescription(const std::string& bindingName,
47  const std::string& shortDescription);
48 };
49 
51 {
52  public:
63  LongDescription(const std::string& bindingName,
64  const std::function<std::string()>& longDescription);
65 };
66 
67 class Example
68 {
69  public:
77  Example(const std::string& bindingName,
78  const std::function<std::string()>& example);
79 };
80 
81 class SeeAlso
82 {
83  public:
92  SeeAlso(const std::string& bindingName,
93  const std::string& description,
94  const std::string& link);
95 };
96 
97 } // namespace util
98 } // namespace mlpack
99 
100 // Include implementation.
101 #include "program_doc_impl.hpp"
102 
103 #endif
Linear algebra utility functions, generally performed on matrices or vectors.
BindingName(const std::string &bindingName, const std::string &name)
Construct a BindingName object.