BindingInfo Class Reference

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

Static Public Member Functions

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

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

 
static void RegisterProgramDoc (const std::string &bindingName, const util::ProgramDoc &programDoc)
 Register a ProgramDoc object with the given bindingName. More...

 

Detailed Description

The BindingInfo class is used by the Markdown documentation generator to store multiple ProgramDoc 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

◆ GetProgramDoc()

static util::ProgramDoc& GetProgramDoc ( const std::string &  bindingName)
static

Return a ProgramDoc object for a given bindingName.

◆ 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().

◆ RegisterProgramDoc()

static void RegisterProgramDoc ( const std::string &  bindingName,
const util::ProgramDoc programDoc 
)
static

Register a ProgramDoc object with the given bindingName.

Referenced by ProgramDocWrapper::ProgramDocWrapper().


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