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

Detailed Description

Definition at line 50 of file program_doc.hpp.

Constructor & Destructor Documentation

LongDescription	(	const std::string &	bindingName,
		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 for a given bindingName.

Parameters

bindingName	Name of the binding.
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: