mlpack::util::ShortDescription Class Reference

Public Member Functions
	ShortDescription (const std::string &shortDescription)
	Construct a ShortDescription object. More...

Constructor & Destructor Documentation

ShortDescription()

ShortDescription::ShortDescription

(

const std::string &

shortDescription

)

Construct a ShortDescription object.

When constructed, it will register itself with IO. A fatal error will be thrown if more than one is constructed.

Parameters

shortDescription

A short two-sentence description of the binding, what it does, and what it is useful for.

---

The documentation for this class was generated from the following files:

• src/mlpack/core/util/program_doc.hpp
• src/mlpack/core/util/program_doc.cpp