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/datatypes_8h.tex | 147 +++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 147 insertions(+) create mode 100644 doc/latex/datatypes_8h.tex (limited to 'doc/latex/datatypes_8h.tex') diff --git a/doc/latex/datatypes_8h.tex b/doc/latex/datatypes_8h.tex new file mode 100644 index 0000000..9b96e3d --- /dev/null +++ b/doc/latex/datatypes_8h.tex @@ -0,0 +1,147 @@ +\section{datatypes.h File Reference} +\label{datatypes_8h}\index{datatypes.h@{datatypes.h}} +\subsection*{Defines} +\begin{CompactItemize} +\item +\#define {\bf SEQ\_\-NR\_\-T\_\-NTOH}(a)~ntohl(a) +\item +\#define {\bf SEQ\_\-NR\_\-T\_\-HTON}(a)~htonl(a) +\item +\#define {\bf SENDER\_\-ID\_\-T\_\-NTOH}(a)~ntohs(a) +\item +\#define {\bf SENDER\_\-ID\_\-T\_\-HTON}(a)~htons(a) +\item +\#define {\bf PAYLOAD\_\-TYPE\_\-T\_\-NTOH}(a)~ntohs(a) +\item +\#define {\bf PAYLOAD\_\-TYPE\_\-T\_\-HTON}(a)~htons(a) +\item +\#define {\bf AUTH\_\-TAG\_\-T\_\-NTOH}(a)~ntohl(a) +\item +\#define {\bf AUTH\_\-TAG\_\-T\_\-HTON}(a)~htonl(a) +\end{CompactItemize} +\subsection*{Typedefs} +\begin{CompactItemize} +\item +typedef signed char {\bf int8\_\-t} +\item +typedef unsigned char {\bf u\_\-int8\_\-t} +\item +typedef signed short {\bf int16} +\item +typedef unsigned short {\bf u\_\-int16\_\-t} +\item +typedef signed int {\bf int32} +\item +typedef unsigned int {\bf u\_\-int32\_\-t} +\item +typedef {\bf u\_\-int32\_\-t} {\bf window\_\-size\_\-t} +\item +typedef {\bf u\_\-int32\_\-t} {\bf seq\_\-nr\_\-t} +\item +typedef {\bf u\_\-int16\_\-t} {\bf sender\_\-id\_\-t} +\item +typedef {\bf u\_\-int16\_\-t} {\bf payload\_\-type\_\-t} +\item +typedef {\bf u\_\-int32\_\-t} {\bf auth\_\-tag\_\-t} +\end{CompactItemize} + + +\subsection{Define Documentation} +\index{datatypes.h@{datatypes.h}!AUTH_TAG_T_HTON@{AUTH\_\-TAG\_\-T\_\-HTON}} +\index{AUTH_TAG_T_HTON@{AUTH\_\-TAG\_\-T\_\-HTON}!datatypes.h@{datatypes.h}} +\subsubsection{\setlength{\rightskip}{0pt plus 5cm}\#define AUTH\_\-TAG\_\-T\_\-HTON(a)~htonl(a)}\label{datatypes_8h_e08ddfb4ec6d5f44e41d776eec5d6c4b} + + +\index{datatypes.h@{datatypes.h}!AUTH_TAG_T_NTOH@{AUTH\_\-TAG\_\-T\_\-NTOH}} +\index{AUTH_TAG_T_NTOH@{AUTH\_\-TAG\_\-T\_\-NTOH}!datatypes.h@{datatypes.h}} +\subsubsection{\setlength{\rightskip}{0pt plus 5cm}\#define AUTH\_\-TAG\_\-T\_\-NTOH(a)~ntohl(a)}\label{datatypes_8h_dfe492fa271ed259fdca87aec19b6e4c} + + +\index{datatypes.h@{datatypes.h}!PAYLOAD_TYPE_T_HTON@{PAYLOAD\_\-TYPE\_\-T\_\-HTON}} +\index{PAYLOAD_TYPE_T_HTON@{PAYLOAD\_\-TYPE\_\-T\_\-HTON}!datatypes.h@{datatypes.h}} +\subsubsection{\setlength{\rightskip}{0pt plus 5cm}\#define PAYLOAD\_\-TYPE\_\-T\_\-HTON(a)~htons(a)}\label{datatypes_8h_173b0a15f5670e90c9bf443d70822753} + + +\index{datatypes.h@{datatypes.h}!PAYLOAD_TYPE_T_NTOH@{PAYLOAD\_\-TYPE\_\-T\_\-NTOH}} +\index{PAYLOAD_TYPE_T_NTOH@{PAYLOAD\_\-TYPE\_\-T\_\-NTOH}!datatypes.h@{datatypes.h}} +\subsubsection{\setlength{\rightskip}{0pt plus 5cm}\#define PAYLOAD\_\-TYPE\_\-T\_\-NTOH(a)~ntohs(a)}\label{datatypes_8h_2974b1523b0f364e348edb469cf2814f} + + +\index{datatypes.h@{datatypes.h}!SENDER_ID_T_HTON@{SENDER\_\-ID\_\-T\_\-HTON}} +\index{SENDER_ID_T_HTON@{SENDER\_\-ID\_\-T\_\-HTON}!datatypes.h@{datatypes.h}} +\subsubsection{\setlength{\rightskip}{0pt plus 5cm}\#define SENDER\_\-ID\_\-T\_\-HTON(a)~htons(a)}\label{datatypes_8h_8ecfc6bb5938ad141419ba4f62fc2eca} + + +\index{datatypes.h@{datatypes.h}!SENDER_ID_T_NTOH@{SENDER\_\-ID\_\-T\_\-NTOH}} +\index{SENDER_ID_T_NTOH@{SENDER\_\-ID\_\-T\_\-NTOH}!datatypes.h@{datatypes.h}} +\subsubsection{\setlength{\rightskip}{0pt plus 5cm}\#define SENDER\_\-ID\_\-T\_\-NTOH(a)~ntohs(a)}\label{datatypes_8h_f0e02829fc534eac0fdec4712459dea4} + + +\index{datatypes.h@{datatypes.h}!SEQ_NR_T_HTON@{SEQ\_\-NR\_\-T\_\-HTON}} +\index{SEQ_NR_T_HTON@{SEQ\_\-NR\_\-T\_\-HTON}!datatypes.h@{datatypes.h}} +\subsubsection{\setlength{\rightskip}{0pt plus 5cm}\#define SEQ\_\-NR\_\-T\_\-HTON(a)~htonl(a)}\label{datatypes_8h_18c9cf2c5be6cb1e16a319a4da44989b} + + +\index{datatypes.h@{datatypes.h}!SEQ_NR_T_NTOH@{SEQ\_\-NR\_\-T\_\-NTOH}} +\index{SEQ_NR_T_NTOH@{SEQ\_\-NR\_\-T\_\-NTOH}!datatypes.h@{datatypes.h}} +\subsubsection{\setlength{\rightskip}{0pt plus 5cm}\#define SEQ\_\-NR\_\-T\_\-NTOH(a)~ntohl(a)}\label{datatypes_8h_4c349b0b408b8f654c8713c205f33f60} + + + + +\subsection{Typedef Documentation} +\index{datatypes.h@{datatypes.h}!auth_tag_t@{auth\_\-tag\_\-t}} +\index{auth_tag_t@{auth\_\-tag\_\-t}!datatypes.h@{datatypes.h}} +\subsubsection{\setlength{\rightskip}{0pt plus 5cm}typedef {\bf u\_\-int32\_\-t} {\bf auth\_\-tag\_\-t}}\label{datatypes_8h_3618ec768f7f5b8ed61f2ad534e1882d} + + +\index{datatypes.h@{datatypes.h}!int16@{int16}} +\index{int16@{int16}!datatypes.h@{datatypes.h}} +\subsubsection{\setlength{\rightskip}{0pt plus 5cm}typedef signed short {\bf int16}}\label{datatypes_8h_259fa4834387bd68627ddf37bb3ebdb9} + + +\index{datatypes.h@{datatypes.h}!int32@{int32}} +\index{int32@{int32}!datatypes.h@{datatypes.h}} +\subsubsection{\setlength{\rightskip}{0pt plus 5cm}typedef signed int {\bf int32}}\label{datatypes_8h_43d43196463bde49cb067f5c20ab8481} + + +\index{datatypes.h@{datatypes.h}!int8_t@{int8\_\-t}} +\index{int8_t@{int8\_\-t}!datatypes.h@{datatypes.h}} +\subsubsection{\setlength{\rightskip}{0pt plus 5cm}typedef signed char {\bf int8\_\-t}}\label{datatypes_8h_ef44329758059c91c76d334e8fc09700} + + +\index{datatypes.h@{datatypes.h}!payload_type_t@{payload\_\-type\_\-t}} +\index{payload_type_t@{payload\_\-type\_\-t}!datatypes.h@{datatypes.h}} +\subsubsection{\setlength{\rightskip}{0pt plus 5cm}typedef {\bf u\_\-int16\_\-t} {\bf payload\_\-type\_\-t}}\label{datatypes_8h_cb4c65fa561443848e729372d970654d} + + +\index{datatypes.h@{datatypes.h}!sender_id_t@{sender\_\-id\_\-t}} +\index{sender_id_t@{sender\_\-id\_\-t}!datatypes.h@{datatypes.h}} +\subsubsection{\setlength{\rightskip}{0pt plus 5cm}typedef {\bf u\_\-int16\_\-t} {\bf sender\_\-id\_\-t}}\label{datatypes_8h_c8be006c348a522ae126f67f7b2aaf4e} + + +\index{datatypes.h@{datatypes.h}!seq_nr_t@{seq\_\-nr\_\-t}} +\index{seq_nr_t@{seq\_\-nr\_\-t}!datatypes.h@{datatypes.h}} +\subsubsection{\setlength{\rightskip}{0pt plus 5cm}typedef {\bf u\_\-int32\_\-t} {\bf seq\_\-nr\_\-t}}\label{datatypes_8h_317be74a3176b4149a817241bd69f9b2} + + +\index{datatypes.h@{datatypes.h}!u_int16_t@{u\_\-int16\_\-t}} +\index{u_int16_t@{u\_\-int16\_\-t}!datatypes.h@{datatypes.h}} +\subsubsection{\setlength{\rightskip}{0pt plus 5cm}typedef unsigned short {\bf u\_\-int16\_\-t}}\label{datatypes_8h_3aa89f830bb876725b238e6a2a67a809} + + +\index{datatypes.h@{datatypes.h}!u_int32_t@{u\_\-int32\_\-t}} +\index{u_int32_t@{u\_\-int32\_\-t}!datatypes.h@{datatypes.h}} +\subsubsection{\setlength{\rightskip}{0pt plus 5cm}typedef unsigned int {\bf u\_\-int32\_\-t}}\label{datatypes_8h_1382fcaa92d837ce7c0961788c8243d7} + + +\index{datatypes.h@{datatypes.h}!u_int8_t@{u\_\-int8\_\-t}} +\index{u_int8_t@{u\_\-int8\_\-t}!datatypes.h@{datatypes.h}} +\subsubsection{\setlength{\rightskip}{0pt plus 5cm}typedef unsigned char {\bf u\_\-int8\_\-t}}\label{datatypes_8h_40a40c6e9649a4e3806e76fef247d241} + + +\index{datatypes.h@{datatypes.h}!window_size_t@{window\_\-size\_\-t}} +\index{window_size_t@{window\_\-size\_\-t}!datatypes.h@{datatypes.h}} +\subsubsection{\setlength{\rightskip}{0pt plus 5cm}typedef {\bf u\_\-int32\_\-t} {\bf window\_\-size\_\-t}}\label{datatypes_8h_0246b9fac0b861d94e0e4cc9ae2e5070} + + -- cgit v1.2.3