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