This structure holds all of the information about bindings documentation. More...

Public Attributes
std::string	programName
	Name of the binding.

std::string	shortDescription
	A short two-sentence description of the binding, what it does, and what it is useful for. More...

std::function< std::string()>	longDescription
	Long string containing documentation on what it is. More...

std::vector< std::function< std::string()> >	example
	Documentation on how to use the binding.

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>. More...

Detailed Description

This structure holds all of the information about bindings documentation.

Member Data Documentation

std::function<std::string()> mlpack::util::BindingDetails::longDescription

Long string containing documentation on what it is.

No newline characters are necessary; this is taken care of by IO later.

std::vector<std::pair<std::string, std::string> > mlpack::util::BindingDetails::seeAlso

A set of pairs of strings with useful "see also" information; each pair is <description, url>.

std::string mlpack::util::BindingDetails::shortDescription

A short two-sentence description of the binding, what it does, and what it is useful for.

The documentation for this struct was generated from the following file: