added doxygen generatet documentation

1 files changed, 98 insertions, 0 deletions

diff --git a/doc/latex/classKeyDerivation.tex b/doc/latex/classKeyDerivation.tex
new file mode 100644
index 0000000..9d38b9d
--- /dev/null
+++ b/doc/latex/classKeyDerivation.tex
@@ -0,0 +1,98 @@
+\section{Key\-Derivation Class Reference}
+\label{classKeyDerivation}\index{KeyDerivation@{KeyDerivation}}
+{\tt \#include $<$key\-Derivation.h$>$}
+
+\subsection*{Public Member Functions}
+\begin{CompactItemize}
+\item 
+{\bf Key\-Derivation} ()
+\item 
+virtual {\bf $\sim$Key\-Derivation} ()
+\item 
+void {\bf init} ({\bf Buffer} key, {\bf Buffer} salt)
+\item 
+err\_\-status\_\-t {\bf set\-Log\-KDRate} (const uint8\_\-t ld\_\-rate)
+\item 
+err\_\-status\_\-t {\bf generate} ({\bf satp\_\-prf\_\-label} label, {\bf seq\_\-nr\_\-t} seq\_\-nr, {\bf Buffer} \&key, uint32\_\-t length)
+\item 
+void {\bf clear} ()
+\end{CompactItemize}
+\subsection*{Static Public Attributes}
+\begin{CompactItemize}
+\item 
+static const std::string {\bf MIN\_\-GCRYPT\_\-VERSION}
+\end{CompactItemize}
+\subsection*{Protected Attributes}
+\begin{CompactItemize}
+\item 
+{\bf int8\_\-t} {\bf ld\_\-kdr\_\-}
+\item 
+{\bf Buffer} {\bf salt\_\-}
+\item 
+gcry\_\-cipher\_\-hd\_\-t {\bf cipher\_\-}
+\end{CompactItemize}
+
+
+\subsection{Constructor \& Destructor Documentation}
+\index{KeyDerivation@{Key\-Derivation}!KeyDerivation@{KeyDerivation}}
+\index{KeyDerivation@{KeyDerivation}!KeyDerivation@{Key\-Derivation}}
+\subsubsection{\setlength{\rightskip}{0pt plus 5cm}Key\-Derivation::Key\-Derivation ()\hspace{0.3cm}{\tt  [inline]}}\label{classKeyDerivation_07c3735d1b2e1285b6c427a2706ebc67}
+
+
+\index{KeyDerivation@{Key\-Derivation}!~KeyDerivation@{$\sim$KeyDerivation}}
+\index{~KeyDerivation@{$\sim$KeyDerivation}!KeyDerivation@{Key\-Derivation}}
+\subsubsection{\setlength{\rightskip}{0pt plus 5cm}virtual Key\-Derivation::$\sim$Key\-Derivation ()\hspace{0.3cm}{\tt  [inline, virtual]}}\label{classKeyDerivation_ccce2c32370be2388ca0a977fef1f6cc}
+
+
+
+
+\subsection{Member Function Documentation}
+\index{KeyDerivation@{Key\-Derivation}!init@{init}}
+\index{init@{init}!KeyDerivation@{Key\-Derivation}}
+\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void Key\-Derivation::init ({\bf Buffer} {\em key}, {\bf Buffer} {\em salt})}\label{classKeyDerivation_5f03e97de1a041f6012d1fcfabf13773}
+
+
+\index{KeyDerivation@{Key\-Derivation}!setLogKDRate@{setLogKDRate}}
+\index{setLogKDRate@{setLogKDRate}!KeyDerivation@{Key\-Derivation}}
+\subsubsection{\setlength{\rightskip}{0pt plus 5cm}err\_\-status\_\-t Key\-Derivation::set\-Log\-KDRate (const uint8\_\-t {\em ld\_\-rate})}\label{classKeyDerivation_1c6d7a055b6b5b88076e15218f936663}
+
+
+\index{KeyDerivation@{Key\-Derivation}!generate@{generate}}
+\index{generate@{generate}!KeyDerivation@{Key\-Derivation}}
+\subsubsection{\setlength{\rightskip}{0pt plus 5cm}err\_\-status\_\-t Key\-Derivation::generate ({\bf satp\_\-prf\_\-label} {\em label}, {\bf seq\_\-nr\_\-t} {\em seq\_\-nr}, {\bf Buffer} \& {\em key}, uint32\_\-t {\em length})}\label{classKeyDerivation_025e21ecdd0389b768eaa61fed660c86}
+
+
+\index{KeyDerivation@{Key\-Derivation}!clear@{clear}}
+\index{clear@{clear}!KeyDerivation@{Key\-Derivation}}
+\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void Key\-Derivation::clear ()}\label{classKeyDerivation_8d8c405ee7c3753b4807b36a8cbe537a}
+
+
+
+
+\subsection{Member Data Documentation}
+\index{KeyDerivation@{Key\-Derivation}!MIN_GCRYPT_VERSION@{MIN\_\-GCRYPT\_\-VERSION}}
+\index{MIN_GCRYPT_VERSION@{MIN\_\-GCRYPT\_\-VERSION}!KeyDerivation@{Key\-Derivation}}
+\subsubsection{\setlength{\rightskip}{0pt plus 5cm}const std::string {\bf Key\-Derivation::MIN\_\-GCRYPT\_\-VERSION}\hspace{0.3cm}{\tt  [static]}}\label{classKeyDerivation_9aaf24245f7dec6e68fc24541abce94b}
+
+
+\index{KeyDerivation@{Key\-Derivation}!ld_kdr_@{ld\_\-kdr\_\-}}
+\index{ld_kdr_@{ld\_\-kdr\_\-}!KeyDerivation@{Key\-Derivation}}
+\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf int8\_\-t} {\bf Key\-Derivation::ld\_\-kdr\_\-}\hspace{0.3cm}{\tt  [protected]}}\label{classKeyDerivation_426dcd34d3b60191a3db55dd970eeb17}
+
+
+\index{KeyDerivation@{Key\-Derivation}!salt_@{salt\_\-}}
+\index{salt_@{salt\_\-}!KeyDerivation@{Key\-Derivation}}
+\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf Buffer} {\bf Key\-Derivation::salt\_\-}\hspace{0.3cm}{\tt  [protected]}}\label{classKeyDerivation_52e057f1085920a61ea44c5c9936865c}
+
+
+\index{KeyDerivation@{Key\-Derivation}!cipher_@{cipher\_\-}}
+\index{cipher_@{cipher\_\-}!KeyDerivation@{Key\-Derivation}}
+\subsubsection{\setlength{\rightskip}{0pt plus 5cm}gcry\_\-cipher\_\-hd\_\-t {\bf Key\-Derivation::cipher\_\-}\hspace{0.3cm}{\tt  [protected]}}\label{classKeyDerivation_6b7dd9a922de96a8f76cf6c453adab28}
+
+
+
+
+The documentation for this class was generated from the following files:\begin{CompactItemize}
+\item 
+{\bf key\-Derivation.h}\item 
+{\bf key\-Derivation.cpp}\end{CompactItemize}