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/keyDerivation_8h.tex | 53 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 53 insertions(+) create mode 100644 doc/latex/keyDerivation_8h.tex (limited to 'doc/latex/keyDerivation_8h.tex') diff --git a/doc/latex/keyDerivation_8h.tex b/doc/latex/keyDerivation_8h.tex new file mode 100644 index 0000000..1dc84ca --- /dev/null +++ b/doc/latex/keyDerivation_8h.tex @@ -0,0 +1,53 @@ +\section{key\-Derivation.h File Reference} +\label{keyDerivation_8h}\index{keyDerivation.h@{keyDerivation.h}} +{\tt \#include \char`\"{}datatypes.h\char`\"{}}\par +{\tt \#include \char`\"{}buffer.h\char`\"{}}\par +{\tt \#include $<$string$>$}\par +{\tt \#include $<$srtp/crypto\_\-kernel.h$>$}\par +{\tt \#include $<$gcrypt.h$>$}\par +\subsection*{Classes} +\begin{CompactItemize} +\item +class {\bf Key\-Derivation} +\end{CompactItemize} +\subsection*{Enumerations} +\begin{CompactItemize} +\item +enum {\bf satp\_\-prf\_\-label} \{ {\bf label\_\-satp\_\-encryption} = 0x00, +{\bf label\_\-satp\_\-msg\_\-auth} = 0x01, +{\bf label\_\-satp\_\-salt} = 0x02 + \} +\end{CompactItemize} +\subsection*{Variables} +\begin{CompactItemize} +\item +const std::string {\bf MIN\_\-GCRYPT\_\-VERSION} = \char`\"{}1.2.3\char`\"{} +\end{CompactItemize} + + +\subsection{Enumeration Type Documentation} +\index{keyDerivation.h@{key\-Derivation.h}!satp_prf_label@{satp\_\-prf\_\-label}} +\index{satp_prf_label@{satp\_\-prf\_\-label}!keyDerivation.h@{key\-Derivation.h}} +\subsubsection{\setlength{\rightskip}{0pt plus 5cm}enum {\bf satp\_\-prf\_\-label}}\label{keyDerivation_8h_4829fcd87054af9b3ced79bbac1ce1eb} + + +\begin{Desc} +\item[Enumerator: ]\par +\begin{description} +\index{label_satp_encryption@{label\_\-satp\_\-encryption}!keyDerivation.h@{keyDerivation.h}}\index{keyDerivation.h@{keyDerivation.h}!label_satp_encryption@{label\_\-satp\_\-encryption}}\item[{\em +label\_\-satp\_\-encryption\label{keyDerivation_8h_4829fcd87054af9b3ced79bbac1ce1eb4cece0d357861fb1d1b4087f05284543} +}]\index{label_satp_msg_auth@{label\_\-satp\_\-msg\_\-auth}!keyDerivation.h@{keyDerivation.h}}\index{keyDerivation.h@{keyDerivation.h}!label_satp_msg_auth@{label\_\-satp\_\-msg\_\-auth}}\item[{\em +label\_\-satp\_\-msg\_\-auth\label{keyDerivation_8h_4829fcd87054af9b3ced79bbac1ce1ebd45276cca55df72c149b44bbf80757c3} +}]\index{label_satp_salt@{label\_\-satp\_\-salt}!keyDerivation.h@{keyDerivation.h}}\index{keyDerivation.h@{keyDerivation.h}!label_satp_salt@{label\_\-satp\_\-salt}}\item[{\em +label\_\-satp\_\-salt\label{keyDerivation_8h_4829fcd87054af9b3ced79bbac1ce1eb78eb4c963e5ca87676c0a713e2fd9aa4} +}]\end{description} +\end{Desc} + + + +\subsection{Variable Documentation} +\index{keyDerivation.h@{key\-Derivation.h}!MIN_GCRYPT_VERSION@{MIN\_\-GCRYPT\_\-VERSION}} +\index{MIN_GCRYPT_VERSION@{MIN\_\-GCRYPT\_\-VERSION}!keyDerivation.h@{key\-Derivation.h}} +\subsubsection{\setlength{\rightskip}{0pt plus 5cm}const std::string {\bf MIN\_\-GCRYPT\_\-VERSION} = \char`\"{}1.2.3\char`\"{}}\label{keyDerivation_8h_6dcd6ca1447ccea53a7975c2a18f6a83} + + -- cgit v1.2.3