The BindingInfo class is used by the Markdown documentation generator to store multiple documentation objects, indexed by both the binding name (i.e. More...

Static Public Member Functions

static util::BindingDetailsGetBindingDetails (const std::string &bindingName)
 Return a BindingDetails object for a given bindingName. More...

 
static BindingInfoGetSingleton ()
 Get the singleton. More...

 
static std::string & Language ()
 Get or modify the current language (don't set it to something invalid!). More...

 

Public Attributes

std::unordered_map< std::string, util::BindingDetailsmap
 Internally-held map for mapping a binding name to a BindingDetails. More...

 

Detailed Description

The BindingInfo class is used by the Markdown documentation generator to store multiple documentation objects, indexed by both the binding name (i.e.

"knn") and the language (i.e. "cli").

Definition at line 30 of file binding_info.hpp.

Member Function Documentation

◆ GetBindingDetails()

static util::BindingDetails& GetBindingDetails ( const std::string &  bindingName)
static

Return a BindingDetails object for a given bindingName.

◆ GetSingleton()

◆ Language()

static std::string& Language ( )
static

Get or modify the current language (don't set it to something invalid!).

Referenced by mlpack::bindings::markdown::DefaultParam(), mlpack::bindings::markdown::GetPrintableType(), and mlpack::bindings::markdown::PrintTypeDoc().

Member Data Documentation

◆ map

std::unordered_map<std::string, util::BindingDetails> map

The documentation for this class was generated from the following file:
  • /home/jenkins-mlpack/mlpack.org/_src/mlpack-git/src/mlpack/bindings/markdown/binding_info.hpp