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 BindingName
{
 public:
  BindingName(const std::string& bindingName, const std::string& name);
};

class ShortDescription
{
 public:
  ShortDescription(const std::string& bindingName,
                   const std::string& shortDescription);
};

class LongDescription
{
 public:
  LongDescription(const std::string& bindingName,
                  const std::function<std::string()>& longDescription);
};

class Example
{
 public:
  Example(const std::string& bindingName,
          const std::function<std::string()>& example);
};

class SeeAlso
{
 public:
  SeeAlso(const std::string& bindingName,
          const std::string& description,
          const std::string& link);
};

} // namespace util
} // namespace mlpack

#endif