From f253764c93f49dcdfe01b9e3f4d2a1352406b8f1 Mon Sep 17 00:00:00 2001 From: Silvio Date: Tue, 22 Feb 2011 10:37:10 -0300 Subject: Documentation update --- doc/latex/classMaleteDb.tex | 45 +++++++++++++++++++++++++++++++++++++-------- 1 file changed, 37 insertions(+), 8 deletions(-) (limited to 'doc/latex/classMaleteDb.tex') diff --git a/doc/latex/classMaleteDb.tex b/doc/latex/classMaleteDb.tex index 0baaf89..6787941 100644 --- a/doc/latex/classMaleteDb.tex +++ b/doc/latex/classMaleteDb.tex @@ -5,7 +5,7 @@ Inheritance diagram for MaleteDb:\begin{figure}[H] \begin{center} \leavevmode -\includegraphics[height=2cm]{classMaleteDb} +\includegraphics[height=2.000000cm]{classMaleteDb} \end{center} \end{figure} \subsection*{Public Member Functions} @@ -50,7 +50,11 @@ This implementation is currently outdated and lacks basic functionalities such a \hypertarget{classMaleteDb_a60f87371bc1ec156b010e5b38b4c22e2}{ \index{MaleteDb@{MaleteDb}!\_\-\_\-construct@{\_\-\_\-construct}} \index{\_\-\_\-construct@{\_\-\_\-construct}!MaleteDb@{MaleteDb}} -\subsubsection[{\_\-\_\-construct}]{\setlength{\rightskip}{0pt plus 5cm}MaleteDb::\_\-\_\-construct (\$ {\em schema})}} +\subsubsection[{\_\-\_\-construct}]{\setlength{\rightskip}{0pt plus 5cm}MaleteDb::\_\-\_\-construct ( +\begin{DoxyParamCaption} +\item[{\$}]{ schema} +\end{DoxyParamCaption} +)}} \label{classMaleteDb_a60f87371bc1ec156b010e5b38b4c22e2} Constructor. @@ -67,7 +71,12 @@ Implements \hyperlink{interfaceIsisDb_ae1c0a3496d55f710d34c5c19ada7a66b}{IsisDb} \hypertarget{classMaleteDb_ab2da32d84af17df79d947ae32257b4ec}{ \index{MaleteDb@{MaleteDb}!check@{check}} \index{check@{check}!MaleteDb@{MaleteDb}} -\subsubsection[{check}]{\setlength{\rightskip}{0pt plus 5cm}MaleteDb::check (\$ {\em schema}, \/ \$ {\em section} = {\ttfamily NULL})}} +\subsubsection[{check}]{\setlength{\rightskip}{0pt plus 5cm}MaleteDb::check ( +\begin{DoxyParamCaption} +\item[{\$}]{ schema, } +\item[{\$}]{ section = {\ttfamily NULL}} +\end{DoxyParamCaption} +)}} \label{classMaleteDb_ab2da32d84af17df79d947ae32257b4ec} Check configuration. @@ -81,7 +90,11 @@ Implements \hyperlink{interfaceIsisDb_af681b8f990b579f1835aa7ba4c83f1b8}{IsisDb} \hypertarget{classMaleteDb_a5c6cb09a072e5d2ddce31c77098ccba4}{ \index{MaleteDb@{MaleteDb}!entries@{entries}} \index{entries@{entries}!MaleteDb@{MaleteDb}} -\subsubsection[{entries}]{\setlength{\rightskip}{0pt plus 5cm}MaleteDb::entries ()}} +\subsubsection[{entries}]{\setlength{\rightskip}{0pt plus 5cm}MaleteDb::entries ( +\begin{DoxyParamCaption} +{} +\end{DoxyParamCaption} +)}} \label{classMaleteDb_a5c6cb09a072e5d2ddce31c77098ccba4} Return number of entries in the database. @@ -97,7 +110,11 @@ Implements \hyperlink{interfaceIsisDb_a86f38eca2b6d0835b60770d8a4e511ff}{IsisDb} \hypertarget{classMaleteDb_a4f16c48facae498d0db1a042e9727d04}{ \index{MaleteDb@{MaleteDb}!example@{example}} \index{example@{example}!MaleteDb@{MaleteDb}} -\subsubsection[{example}]{\setlength{\rightskip}{0pt plus 5cm}MaleteDb::example ()}} +\subsubsection[{example}]{\setlength{\rightskip}{0pt plus 5cm}MaleteDb::example ( +\begin{DoxyParamCaption} +{} +\end{DoxyParamCaption} +)}} \label{classMaleteDb_a4f16c48facae498d0db1a042e9727d04} Return an example schema. @@ -111,7 +128,11 @@ Implements \hyperlink{interfaceIsisDb_a857c10d90da64067efa17afb2f32edb6}{IsisDb} \hypertarget{classMaleteDb_a17562c1c53594762454d65be823fcdb5}{ \index{MaleteDb@{MaleteDb}!logger@{logger}} \index{logger@{logger}!MaleteDb@{MaleteDb}} -\subsubsection[{logger}]{\setlength{\rightskip}{0pt plus 5cm}MaleteDb::logger (\$ {\em message})}} +\subsubsection[{logger}]{\setlength{\rightskip}{0pt plus 5cm}MaleteDb::logger ( +\begin{DoxyParamCaption} +\item[{\$}]{ message} +\end{DoxyParamCaption} +)}} \label{classMaleteDb_a17562c1c53594762454d65be823fcdb5} Class logger. @@ -121,7 +142,11 @@ Class logger. \hypertarget{classMaleteDb_ad2a65876db24adc388afce465e0c153e}{ \index{MaleteDb@{MaleteDb}!read@{read}} \index{read@{read}!MaleteDb@{MaleteDb}} -\subsubsection[{read}]{\setlength{\rightskip}{0pt plus 5cm}MaleteDb::read (\$ {\em id})}} +\subsubsection[{read}]{\setlength{\rightskip}{0pt plus 5cm}MaleteDb::read ( +\begin{DoxyParamCaption} +\item[{\$}]{ id} +\end{DoxyParamCaption} +)}} \label{classMaleteDb_ad2a65876db24adc388afce465e0c153e} Read an entry. @@ -137,7 +162,11 @@ Implements \hyperlink{interfaceIsisDb_a68335ec0db01ef03f0725621b38b5686}{IsisDb} \hypertarget{classMaleteDb_ac87c3ac1b3d9a6297be8574aa303e033}{ \index{MaleteDb@{MaleteDb}!tag@{tag}} \index{tag@{tag}!MaleteDb@{MaleteDb}} -\subsubsection[{tag}]{\setlength{\rightskip}{0pt plus 5cm}MaleteDb::tag (\$ {\em results})}} +\subsubsection[{tag}]{\setlength{\rightskip}{0pt plus 5cm}MaleteDb::tag ( +\begin{DoxyParamCaption} +\item[{\$}]{ results} +\end{DoxyParamCaption} +)}} \label{classMaleteDb_ac87c3ac1b3d9a6297be8574aa303e033} Tag results of a db query. -- cgit v1.2.3