From 7763f07327f3abce839a690df46ced3bfd1d3d09 Mon Sep 17 00:00:00 2001 From: Erwin Nindl Date: Sun, 7 Oct 2007 22:07:03 +0000 Subject: added doxygen generatet documentation --- doc/latex/classSignalHandler.tex | 76 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 76 insertions(+) create mode 100644 doc/latex/classSignalHandler.tex (limited to 'doc/latex/classSignalHandler.tex') diff --git a/doc/latex/classSignalHandler.tex b/doc/latex/classSignalHandler.tex new file mode 100644 index 0000000..2cf61d7 --- /dev/null +++ b/doc/latex/classSignalHandler.tex @@ -0,0 +1,76 @@ +\section{Signal\-Handler Class Reference} +\label{classSignalHandler}\index{SignalHandler@{SignalHandler}} +{\tt \#include $<$signal\-Controller.h$>$} + +Inheritance diagram for Signal\-Handler::\begin{figure}[H] +\begin{center} +\leavevmode +\includegraphics[height=1.68168cm]{classSignalHandler} +\end{center} +\end{figure} +\subsection*{Public Member Functions} +\begin{CompactItemize} +\item +virtual {\bf $\sim$Signal\-Handler} () +\item +virtual int {\bf handle} () +\end{CompactItemize} +\subsection*{Protected Member Functions} +\begin{CompactItemize} +\item +{\bf Signal\-Handler} (int s) +\end{CompactItemize} +\subsection*{Private Attributes} +\begin{CompactItemize} +\item +int {\bf sig\-Num} +\end{CompactItemize} +\subsection*{Friends} +\begin{CompactItemize} +\item +class {\bf Signal\-Controller} +\end{CompactItemize} + + +\subsection{Constructor \& Destructor Documentation} +\index{SignalHandler@{Signal\-Handler}!~SignalHandler@{$\sim$SignalHandler}} +\index{~SignalHandler@{$\sim$SignalHandler}!SignalHandler@{Signal\-Handler}} +\subsubsection{\setlength{\rightskip}{0pt plus 5cm}virtual Signal\-Handler::$\sim$Signal\-Handler ()\hspace{0.3cm}{\tt [inline, virtual]}}\label{classSignalHandler_a1109d38f8b43bde75420aaeecc1f2b7} + + +\index{SignalHandler@{Signal\-Handler}!SignalHandler@{SignalHandler}} +\index{SignalHandler@{SignalHandler}!SignalHandler@{Signal\-Handler}} +\subsubsection{\setlength{\rightskip}{0pt plus 5cm}Signal\-Handler::Signal\-Handler (int {\em s})\hspace{0.3cm}{\tt [inline, protected]}}\label{classSignalHandler_8f920534650e9cd3cdfbe3c3f8409b4d} + + + + +\subsection{Member Function Documentation} +\index{SignalHandler@{Signal\-Handler}!handle@{handle}} +\index{handle@{handle}!SignalHandler@{Signal\-Handler}} +\subsubsection{\setlength{\rightskip}{0pt plus 5cm}virtual int Signal\-Handler::handle ()\hspace{0.3cm}{\tt [inline, virtual]}}\label{classSignalHandler_e3dbda0de9b4aa4544390818a0d29e28} + + + + +Reimplemented in {\bf Sig\-Int\-Handler} \doxyref{}{p.}{classSigIntHandler_6a7d9a841a5c9b1f50041a8c37774063}, {\bf Sig\-Quit\-Handler} \doxyref{}{p.}{classSigQuitHandler_799f0272c91e7b1bf09411b80811b4dc}, {\bf Sig\-Hup\-Handler} \doxyref{}{p.}{classSigHupHandler_84734b7f79663badeedb720896302d4e}, {\bf Sig\-Usr1Handler} \doxyref{}{p.}{classSigUsr1Handler_578f3ea18e617689032fc165b6436695}, {\bf Sig\-Usr2Handler} \doxyref{}{p.}{classSigUsr2Handler_825a621f1ff10556bb8b289703273e7d}, and {\bf Sig\-Term\-Handler} \doxyref{}{p.}{classSigTermHandler_820fa7f8bb5ef6390133c33c919dbf6f}. + +\subsection{Friends And Related Function Documentation} +\index{SignalHandler@{Signal\-Handler}!SignalController@{SignalController}} +\index{SignalController@{SignalController}!SignalHandler@{Signal\-Handler}} +\subsubsection{\setlength{\rightskip}{0pt plus 5cm}friend class {\bf Signal\-Controller}\hspace{0.3cm}{\tt [friend]}}\label{classSignalHandler_9b5c65d0274d45f20c9ed28852dd66fa} + + + + +\subsection{Member Data Documentation} +\index{SignalHandler@{Signal\-Handler}!sigNum@{sigNum}} +\index{sigNum@{sigNum}!SignalHandler@{Signal\-Handler}} +\subsubsection{\setlength{\rightskip}{0pt plus 5cm}int {\bf Signal\-Handler::sig\-Num}\hspace{0.3cm}{\tt [private]}}\label{classSignalHandler_0585573af0ea6bebf37bda54e5c3c39d} + + + + +The documentation for this class was generated from the following file:\begin{CompactItemize} +\item +{\bf signal\-Controller.h}\end{CompactItemize} -- cgit v1.2.3