BindingDetails Struct Reference

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

Public Attributes

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

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

 
std::string name
 User-friendly name of the binding. More...

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

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

 

Detailed Description

This structure holds all of the information about bindings documentation.

Definition at line 23 of file binding_details.hpp.

Member Data Documentation

◆ example

std::vector<std::function<std::string()> > example

Documentation on how to use the binding.

Definition at line 34 of file binding_details.hpp.

◆ longDescription

std::function<std::string()> longDescription

Long string containing documentation on what it is.

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

Definition at line 32 of file binding_details.hpp.

◆ name

std::string name

User-friendly name of the binding.

Definition at line 26 of file binding_details.hpp.

Referenced by mlpack::bindings::cli::ParseCommandLine().

◆ 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 at line 37 of file binding_details.hpp.

◆ shortDescription

std::string shortDescription

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

Definition at line 29 of file binding_details.hpp.


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