program_doc_wrapper.hpp
Go to the documentation of this file.
1 
8 #ifndef MLPACK_BINDINGS_MARKDOWN_PROGRAM_DOC_WRAPPER_HPP
9 #define MLPACK_BINDINGS_MARKDOWN_PROGRAM_DOC_WRAPPER_HPP
10 
11 #include "binding_info.hpp"
12 
13 namespace mlpack {
14 namespace bindings {
15 namespace markdown {
16 
18 {
19  public:
24  ProgramDocWrapper(const std::string& bindingName,
25  const std::string& programName,
26  const std::string& shortDocumentation,
27  const std::function<std::string()>& documentation,
28  const std::vector<std::pair<std::string, std::string>>&
29  seeAlso)
30  {
31  util::ProgramDoc pd(programName, shortDocumentation, documentation,
32  seeAlso);
33  BindingInfo::RegisterProgramDoc(bindingName, pd);
34  }
35 };
36 
37 } // namespace markdown
38 } // namespace bindings
39 } // namespace mlpack
40 
41 #endif
.hpp
Definition: add_to_po.hpp:21
ProgramDocWrapper(const std::string &bindingName, const std::string &programName, const std::string &shortDocumentation, const std::function< std::string()> &documentation, const std::vector< std::pair< std::string, std::string >> &seeAlso)
Construct a ProgramDoc object and register it with BindingInfo::RegisterProgramDoc().
static void RegisterProgramDoc(const std::string &bindingName, const util::ProgramDoc &programDoc)
Register a ProgramDoc object with the given bindingName.
A static object whose constructor registers program documentation with the CLI class.
Definition: program_doc.hpp:26