program_doc_wrapper.hpp
Go to the documentation of this file.
1 
13 #ifndef MLPACK_BINDINGS_MARKDOWN_PROGRAM_DOC_WRAPPER_HPP
14 #define MLPACK_BINDINGS_MARKDOWN_PROGRAM_DOC_WRAPPER_HPP
15 
16 #include "binding_info.hpp"
17 
18 namespace mlpack {
19 namespace bindings {
20 namespace markdown {
21 
23 {
24  public:
29  ProgramDocWrapper(const std::string& bindingName,
30  const std::string& programName,
31  const std::string& shortDocumentation,
32  const std::function<std::string()>& documentation,
33  const std::vector<std::pair<std::string, std::string>>&
34  seeAlso)
35  {
36  util::ProgramDoc pd(programName, shortDocumentation, documentation,
37  seeAlso);
38  BindingInfo::RegisterProgramDoc(bindingName, pd);
39  }
40 };
41 
42 } // namespace markdown
43 } // namespace bindings
44 } // namespace mlpack
45 
46 #endif
strip_type.hpp
Definition: add_to_po.hpp:21
std::string programName
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