mlpack
binding_details.hpp
Go to the documentation of this file.
1 
12 #ifndef MLPACK_CORE_UTIL_BINDING_DETAILS_HPP
13 #define MLPACK_CORE_UTIL_BINDING_DETAILS_HPP
14 
15 #include <mlpack/prereqs.hpp>
16 #include "program_doc.hpp"
17 
18 namespace mlpack {
19 namespace util {
20 
24 struct BindingDetails
25 {
27  std::string name;
30  std::string shortDescription;
33  std::function<std::string()> longDescription;
35  std::vector<std::function<std::string()>> example;
38  std::vector<std::pair<std::string, std::string>> seeAlso;
39 };
40 
41 } // namespace util
42 } // namespace mlpack
43 
44 #endif
mlpack::util::BindingDetails::example
std::vector< std::function< std::string()> > example
Documentation on how to use the binding.
Definition: binding_details.hpp:35
mlpack
Linear algebra utility functions, generally performed on matrices or vectors.
Definition: add_to_cli11.hpp:21
program_doc.hpp
prereqs.hpp
The core includes that mlpack expects; standard C++ includes and Armadillo.
mlpack::util::BindingDetails::longDescription
std::function< std::string()> longDescription
Long string containing documentation on what it is.
Definition: binding_details.hpp:33
mlpack::util::BindingDetails::shortDescription
std::string shortDescription
A short two-sentence description of the binding, what it does, and what it is useful for...
Definition: binding_details.hpp:30
mlpack::util::BindingDetails::seeAlso
std::vector< std::pair< std::string, std::string > > seeAlso
A set of pairs of strings with useful "see also" information; each pair is <description, url>.
Definition: binding_details.hpp:38
mlpack::util::BindingDetails::name
std::string name
User-friendly name of the binding.
Definition: binding_details.hpp:27
mlpack::util::BindingDetails
This structure holds all of the information about bindings documentation.
Definition: binding_details.hpp:24