LongDescription Class Reference

Public Member Functions
	LongDescription (const std::function< std::string()> &longDescription)
	Construct a LongDescription object. More...

Detailed Description

Definition at line 46 of file program_doc.hpp.

Constructor & Destructor Documentation

LongDescription()

LongDescription

(

const std::function< std::string()> &

longDescription

)

Construct a LongDescription object.

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

Parameters

longDescription

Long string containing documentation on what it is. No newline characters are necessary; this is taken care of by IO later.

---

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