program_doc.hpp

Go to the documentation of this file.

#ifndef MLPACK_CORE_UTIL_PROGRAM_DOC_HPP
#define MLPACK_CORE_UTIL_PROGRAM_DOC_HPP

namespace mlpack {
namespace util {

class ProgramDoc
{
 public:
  ProgramDoc(const std::string& programName,
             const std::string& shortDocumentation,
             const std::function<std::string()>& documentation,
             const std::vector<std::pair<std::string, std::string>>& seeAlso);

  ProgramDoc();

  std::string programName;
  std::string shortDocumentation;
  std::function<std::string()> documentation;
  std::vector<std::pair<std::string, std::string>> seeAlso;
};

} // namespace util
} // namespace mlpack

#endif