\section{Command\-Help Class Reference}
\label{class_command_help}\index{CommandHelp@{CommandHelp}}
Represent help on command.  


{\tt \#include $<$help.h$>$}

\subsection*{Public Member Functions}
\begin{CompactItemize}
\item 
{\bf Command\-Help} (const string \&name, const string \&usage, const string \&desc, const string \&short\-Desc, const t\_\-args \&args)
\begin{CompactList}\small\item\em ctor \item\end{CompactList}\item 
const string \& {\bf get\-Name} () const 
\begin{CompactList}\small\item\em return name of command \item\end{CompactList}\item 
const string \& {\bf get\-Short\-Descr} () const 
\begin{CompactList}\small\item\em return short description of command (will be used in helps list) \item\end{CompactList}\item 
const string \& {\bf get\-Usage} () const 
\begin{CompactList}\small\item\em return typical usage of command \item\end{CompactList}\end{CompactItemize}


\subsection{Detailed Description}
Represent help on command. 

\begin{Desc}
\item[Date:]01-29-2006\end{Desc}
\begin{Desc}
\item[Author:]admin\end{Desc}
\begin{Desc}
\item[{\bf Todo}]\end{Desc}
\begin{Desc}
\item[{\bf Bug}]\end{Desc}




\subsection{Constructor \& Destructor Documentation}
\index{CommandHelp@{Command\-Help}!CommandHelp@{CommandHelp}}
\index{CommandHelp@{CommandHelp}!CommandHelp@{Command\-Help}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}Command\-Help::Command\-Help (const string \& {\em name}, const string \& {\em usage}, const string \& {\em desc}, const string \& {\em short\-Desc}, const t\_\-args \& {\em args})\hspace{0.3cm}{\tt  [inline]}}\label{class_command_help_e7e342132b4521b85270204334e75a44}


ctor 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em name}]name of command \item[{\em usage}]typical usage of command \item[{\em desc}]command description \item[{\em short\-Desc}]command short description (for help list) \item[{\em args}]arguments help \end{description}
\end{Desc}
\begin{Desc}
\item[Returns:]\end{Desc}


\subsection{Member Function Documentation}
\index{CommandHelp@{Command\-Help}!getName@{getName}}
\index{getName@{getName}!CommandHelp@{Command\-Help}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}const string\& Command\-Help::get\-Name () const\hspace{0.3cm}{\tt  [inline]}}\label{class_command_help_233fbd39cb42a5f4340815d2190fd55d}


return name of command 

\begin{Desc}
\item[Returns:]name of command \end{Desc}
\index{CommandHelp@{Command\-Help}!getShortDescr@{getShortDescr}}
\index{getShortDescr@{getShortDescr}!CommandHelp@{Command\-Help}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}const string\& Command\-Help::get\-Short\-Descr () const\hspace{0.3cm}{\tt  [inline]}}\label{class_command_help_16fe8ad9b63ccfe9e68068b04e375a7a}


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

\begin{Desc}
\item[Returns:]short description \end{Desc}
\index{CommandHelp@{Command\-Help}!getUsage@{getUsage}}
\index{getUsage@{getUsage}!CommandHelp@{Command\-Help}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}const string\& Command\-Help::get\-Usage () const\hspace{0.3cm}{\tt  [inline]}}\label{class_command_help_d48e7c744b6290f219c994bf25a00dd3}


return typical usage of command 

\begin{Desc}
\item[Returns:]typical usage \end{Desc}


The documentation for this class was generated from the following files:\begin{CompactItemize}
\item 
H:/projs/dot\-NET/eda/src/modulemanager/help.h\item 
H:/projs/dot\-NET/eda/src/modulemanager/help.cpp\end{CompactItemize}
