Aakash-kaushik/mlpack/binding__details_8hpp_source.html

 #ifndef MLPACK_CORE_UTIL_BINDING_DETAILS_HPP
 #define MLPACK_CORE_UTIL_BINDING_DETAILS_HPP

 #include <mlpack/prereqs.hpp>
 #include "program_doc.hpp"

 namespace mlpack {
 namespace util {

 struct BindingDetails
 {
   std::string programName;
   std::string shortDescription;
   std::function<std::string()> longDescription;
   std::vector<std::function<std::string()>> example;
   std::vector<std::pair<std::string, std::string>> seeAlso;
 };

 } // namespace util
 } // namespace mlpack

 #endif
mlpack::util::BindingDetails::programName
std::string programName
Name of the binding.
Definition: binding_details.hpp:27

mlpack
Linear algebra utility functions, generally performed on matrices or vectors.
Definition: cv.hpp:1

mlpack::util::BindingDetails::longDescription
std::function< std::string()> longDescription
Long string containing documentation on what it is.
Definition: binding_details.hpp:33

program_doc.hpp

prereqs.hpp
The core includes that mlpack expects; standard C++ includes and Armadillo.

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::example
std::vector< std::function< std::string()> > example
Documentation on how to use the binding.
Definition: binding_details.hpp:35

mlpack::util::BindingDetails
This structure holds all of the information about bindings documentation.
Definition: binding_details.hpp:24

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