---
name: "mlpack_util_ProgramDoc"
section: "3"
platform: "linux"
package: "mlpack-doc"
version: "1.0.10-1"
release: "Debian 8 (Jessie)"
platforms: ["linux"]
url: "https://new.carta.tech/mlpack_util_ProgramDoc"
---

# mlpack\_util\_ProgramDoc(3)

A static object whose constructor registers program documentation with the CLI class.

## NAME

mlpack::util::ProgramDoc -

A static object whose constructor registers program documentation with the **CLI** class.

## SYNOPSIS

### Public Member Functions

**ProgramDoc** (const std::string &**programName**, const std::string &**documentation**)\
 *Construct a* **ProgramDoc** *object.*

### Public Attributes

std::string **documentation**\
 *Documentation for what the program does.*  std::string **programName**\
 *The name of the program.*

## Detailed Description

A static object whose constructor registers program documentation with the **CLI** class.

This should not be used outside of **CLI** itself, and you should use the **PROGRAM\_INFO()** macro to declare these objects. Only one **ProgramDoc** object should ever exist.

**See also:**

core/io/cli.hpp, **mlpack::CLI**

Definition at line 90 of file option.hpp.

## Constructor & Destructor Documentation

### mlpack::util::ProgramDoc::ProgramDoc (const std::string &programName, const std::string &documentation)

Construct a **ProgramDoc** object. When constructed, it will register itself with **CLI**.

**Parameters:**

*programName* Short string representing the name of the program. \
 *documentation* Long string containing documentation on how to use the program and what it is. No newline characters are necessary; this is taken care of by **CLI** later.

## Member Data Documentation

### std::string mlpack::util::ProgramDoc::documentation

Documentation for what the program does.

Definition at line 108 of file option.hpp.

### std::string mlpack::util::ProgramDoc::programName

The name of the program.

Definition at line 106 of file option.hpp.

## Author

Generated automatically by Doxygen for MLPACK from the source code.