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/classUDPPacketSource.tex | 64 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 64 insertions(+) create mode 100644 doc/latex/classUDPPacketSource.tex (limited to 'doc/latex/classUDPPacketSource.tex') diff --git a/doc/latex/classUDPPacketSource.tex b/doc/latex/classUDPPacketSource.tex new file mode 100644 index 0000000..8571f5d --- /dev/null +++ b/doc/latex/classUDPPacketSource.tex @@ -0,0 +1,64 @@ +\section{UDPPacket\-Source Class Reference} +\label{classUDPPacketSource}\index{UDPPacketSource@{UDPPacketSource}} +{\tt \#include $<$packet\-Source.h$>$} + +Inheritance diagram for UDPPacket\-Source::\begin{figure}[H] +\begin{center} +\leavevmode +\includegraphics[height=4cm]{classUDPPacketSource} +\end{center} +\end{figure} +\subsection*{Public Member Functions} +\begin{CompactItemize} +\item +{\bf UDPPacket\-Source} () +\item +{\bf UDPPacket\-Source} ({\bf u\_\-int16\_\-t} port) +\item +{\bf UDPPacket\-Source} (std::string localaddr, {\bf u\_\-int16\_\-t} port) +\item +{\bf u\_\-int32\_\-t} {\bf recv} ({\bf Buffer} \&buf, std::string \&addr, {\bf u\_\-int16\_\-t} \&port) +\item +void {\bf send} ({\bf Buffer} \&buf, std::string addr, {\bf u\_\-int16\_\-t} port) +\end{CompactItemize} + + +\subsection{Constructor \& Destructor Documentation} +\index{UDPPacketSource@{UDPPacket\-Source}!UDPPacketSource@{UDPPacketSource}} +\index{UDPPacketSource@{UDPPacketSource}!UDPPacketSource@{UDPPacket\-Source}} +\subsubsection{\setlength{\rightskip}{0pt plus 5cm}UDPPacket\-Source::UDPPacket\-Source ()}\label{classUDPPacketSource_1dda248d4d7b03cb8301557271abc40e} + + +\index{UDPPacketSource@{UDPPacket\-Source}!UDPPacketSource@{UDPPacketSource}} +\index{UDPPacketSource@{UDPPacketSource}!UDPPacketSource@{UDPPacket\-Source}} +\subsubsection{\setlength{\rightskip}{0pt plus 5cm}UDPPacket\-Source::UDPPacket\-Source ({\bf u\_\-int16\_\-t} {\em port})}\label{classUDPPacketSource_b9fd5944db99fd0f89c12b0d74ba5e74} + + +\index{UDPPacketSource@{UDPPacket\-Source}!UDPPacketSource@{UDPPacketSource}} +\index{UDPPacketSource@{UDPPacketSource}!UDPPacketSource@{UDPPacket\-Source}} +\subsubsection{\setlength{\rightskip}{0pt plus 5cm}UDPPacket\-Source::UDPPacket\-Source (std::string {\em localaddr}, {\bf u\_\-int16\_\-t} {\em port})}\label{classUDPPacketSource_1cc870353b550b79f9161cfac41f26fa} + + + + +\subsection{Member Function Documentation} +\index{UDPPacketSource@{UDPPacket\-Source}!recv@{recv}} +\index{recv@{recv}!UDPPacketSource@{UDPPacket\-Source}} +\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf u\_\-int32\_\-t} UDPPacket\-Source::recv ({\bf Buffer} \& {\em buf}, std::string \& {\em addr}, {\bf u\_\-int16\_\-t} \& {\em port})\hspace{0.3cm}{\tt [virtual]}}\label{classUDPPacketSource_a1f7daded0f9ead5599160bae9317eb8} + + + + +Implements {\bf Packet\-Source} \doxyref{}{p.}{classPacketSource_95901be715656540a7273c6c0dc1234e}.\index{UDPPacketSource@{UDPPacket\-Source}!send@{send}} +\index{send@{send}!UDPPacketSource@{UDPPacket\-Source}} +\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void UDPPacket\-Source::send ({\bf Buffer} \& {\em buf}, std::string {\em addr}, {\bf u\_\-int16\_\-t} {\em port})\hspace{0.3cm}{\tt [virtual]}}\label{classUDPPacketSource_376a3b0c861aeb7561e8a9f6866292b9} + + + + +Implements {\bf Packet\-Source} \doxyref{}{p.}{classPacketSource_ffc5eb2c89d1395443432c3cc6b7898b}. + +The documentation for this class was generated from the following files:\begin{CompactItemize} +\item +{\bf packet\-Source.h}\item +{\bf packet\-Source.cpp}\end{CompactItemize} -- cgit v1.2.3