- Main Page
- Classes
- Directories
- Related Pages

- Class List
- Class Hierarchy
- Class Members

# CommandHelp Class Reference

Represent help on command. More...

`#include <help.h>`

List of all members.

## Public Member Functions

| CommandHelp (const string &name, const string &usage, const string &desc, const string &shortDesc, const t_args &args)
| ctor
const string & | getName () const
| return name of command
const string & | getShortDescr () const
| return short description of command (will be used in helps list)
const string & | getUsage () const
| return typical usage of command

## Detailed Description

Represent help on command.

Date:
  01-29-2006

Author:
  admin

Todo:

Bug:

## Constructor & Destructor Documentation

CommandHelp::CommandHelp | ( | const string & | name,
|  | const string & | usage,
|  | const string & | desc,
|  | const string & | shortDesc,
|  | const t_args & | args
| ) | `[inline]`

| ctor

Parameters:

  | name | name of command
  | usage | typical usage of command
  | desc | command description
  | shortDesc | command short description (for help list)
  | args | arguments help

Returns:

## Member Function Documentation

const string& CommandHelp::getName | ( |  | ) | const`[inline]`

| return name of command

Returns:
  name of command

const string& CommandHelp::getShortDescr | ( |  | ) | const`[inline]`

| return short description of command (will be used in helps list)

Returns:
  short description

const string& CommandHelp::getUsage | ( |  | ) | const`[inline]`

| return typical usage of command

Returns:
  typical usage

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

- H:/projs/dotNET/eda/src/modulemanager/help.h
- H:/projs/dotNET/eda/src/modulemanager/help.cpp