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 24 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 35 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 33 of file binding_details.hpp.
◆ name
| std::string name |
User-friendly name of the binding.
Definition at line 27 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 38 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 30 of file binding_details.hpp.
The documentation for this struct was generated from the following file:
- /home/ryan/src/mlpack.org/_src/mlpack-git/src/mlpack/core/util/binding_details.hpp