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/classLock.tex | 62 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 62 insertions(+) create mode 100644 doc/latex/classLock.tex (limited to 'doc/latex/classLock.tex') diff --git a/doc/latex/classLock.tex b/doc/latex/classLock.tex new file mode 100644 index 0000000..5de9514 --- /dev/null +++ b/doc/latex/classLock.tex @@ -0,0 +1,62 @@ +\section{Lock Class Reference} +\label{classLock}\index{Lock@{Lock}} +{\tt \#include $<$thread\-Utils.hpp$>$} + +\subsection*{Public Member Functions} +\begin{CompactItemize} +\item +{\bf Lock} ({\bf Mutex} \&m) +\item +{\bf $\sim$Lock} () +\end{CompactItemize} +\subsection*{Private Member Functions} +\begin{CompactItemize} +\item +{\bf Lock} (const {\bf Lock} \&src) +\item +void {\bf operator=} (const {\bf Lock} \&src) +\end{CompactItemize} +\subsection*{Private Attributes} +\begin{CompactItemize} +\item +{\bf Mutex} \& {\bf mutex} +\end{CompactItemize} + + +\subsection{Constructor \& Destructor Documentation} +\index{Lock@{Lock}!Lock@{Lock}} +\index{Lock@{Lock}!Lock@{Lock}} +\subsubsection{\setlength{\rightskip}{0pt plus 5cm}Lock::Lock ({\bf Mutex} \& {\em m})\hspace{0.3cm}{\tt [inline]}}\label{classLock_2c786576eddddb484a6a02a7dea52904} + + +\index{Lock@{Lock}!~Lock@{$\sim$Lock}} +\index{~Lock@{$\sim$Lock}!Lock@{Lock}} +\subsubsection{\setlength{\rightskip}{0pt plus 5cm}Lock::$\sim$Lock ()\hspace{0.3cm}{\tt [inline]}}\label{classLock_7ab6d9485c8665bb3643710432882971} + + +\index{Lock@{Lock}!Lock@{Lock}} +\index{Lock@{Lock}!Lock@{Lock}} +\subsubsection{\setlength{\rightskip}{0pt plus 5cm}Lock::Lock (const {\bf Lock} \& {\em src})\hspace{0.3cm}{\tt [private]}}\label{classLock_5aba40fb170cf8fbfbe241ecac4b66b2} + + + + +\subsection{Member Function Documentation} +\index{Lock@{Lock}!operator=@{operator=}} +\index{operator=@{operator=}!Lock@{Lock}} +\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void Lock::operator= (const {\bf Lock} \& {\em src})\hspace{0.3cm}{\tt [private]}}\label{classLock_6beb534a89b213d70e4b3bb9b3cde217} + + + + +\subsection{Member Data Documentation} +\index{Lock@{Lock}!mutex@{mutex}} +\index{mutex@{mutex}!Lock@{Lock}} +\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf Mutex}\& {\bf Lock::mutex}\hspace{0.3cm}{\tt [private]}}\label{classLock_41f8817641e260bddb93a7a710736037} + + + + +The documentation for this class was generated from the following file:\begin{CompactItemize} +\item +{\bf thread\-Utils.hpp}\end{CompactItemize} -- cgit v1.2.3