ShortDescription Class Reference

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

Detailed Description

Definition at line 32 of file program_doc.hpp.

Constructor & Destructor Documentation

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 file:

• /home/jenkins-mlpack/mlpack.org/_src/mlpack-3.4.2/src/mlpack/core/util/program_doc.hpp