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

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 &quot;see also&quot; information; each pair is &lt;description, url&gt;.
Definition: binding_details.hpp:38

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

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

string
src mlpack core util version hpp VERSION_HPP_CONTENTS string(REGEX REPLACE".*#define MLPACK_VERSION_MAJOR ([0-9]+).*""\\1"MLPACK_VERSION_MAJOR"${VERSION_HPP_CONTENTS}") string(REGEX REPLACE".* MLPACK_VERSION_MINOR "$
Definition: CMakeLists.txt:79