From f253764c93f49dcdfe01b9e3f4d2a1352406b8f1 Mon Sep 17 00:00:00 2001
From: Silvio <silvio@devlet.com.br>
Date: Tue, 22 Feb 2011 10:37:10 -0300
Subject: Documentation update

---
 doc/latex/classBiblioIsisDb.tex | 109 +++++++++++++++++++++++++++++++++-------
 1 file changed, 92 insertions(+), 17 deletions(-)

(limited to 'doc/latex/classBiblioIsisDb.tex')

diff --git a/doc/latex/classBiblioIsisDb.tex b/doc/latex/classBiblioIsisDb.tex
index 4e933f9..6f85b40 100644
--- a/doc/latex/classBiblioIsisDb.tex
+++ b/doc/latex/classBiblioIsisDb.tex
@@ -5,7 +5,7 @@
 Inheritance diagram for BiblioIsisDb:\begin{figure}[H]
 \begin{center}
 \leavevmode
-\includegraphics[height=2cm]{classBiblioIsisDb}
+\includegraphics[height=2.000000cm]{classBiblioIsisDb}
 \end{center}
 \end{figure}
 \subsection*{Public Member Functions}
@@ -66,7 +66,11 @@ Biblio::Isis implementation of \hyperlink{interfaceIsisDb}{IsisDb}.
 \hypertarget{classBiblioIsisDb_ab2c5ec782b324847e104d8ad35a230af}{
 \index{BiblioIsisDb@{BiblioIsisDb}!\_\-\_\-construct@{\_\-\_\-construct}}
 \index{\_\-\_\-construct@{\_\-\_\-construct}!BiblioIsisDb@{BiblioIsisDb}}
-\subsubsection[{\_\-\_\-construct}]{\setlength{\rightskip}{0pt plus 5cm}BiblioIsisDb::\_\-\_\-construct (\$ {\em schema})}}
+\subsubsection[{\_\-\_\-construct}]{\setlength{\rightskip}{0pt plus 5cm}BiblioIsisDb::\_\-\_\-construct (
+\begin{DoxyParamCaption}
+\item[{\$}]{ schema}
+\end{DoxyParamCaption}
+)}}
 \label{classBiblioIsisDb_ab2c5ec782b324847e104d8ad35a230af}
 Constructor.
 
@@ -83,7 +87,12 @@ Implements \hyperlink{interfaceIsisDb_ae1c0a3496d55f710d34c5c19ada7a66b}{IsisDb}
 \hypertarget{classBiblioIsisDb_ad5704f5c9454ac053e66a489797ba221}{
 \index{BiblioIsisDb@{BiblioIsisDb}!backend@{backend}}
 \index{backend@{backend}!BiblioIsisDb@{BiblioIsisDb}}
-\subsubsection[{backend}]{\setlength{\rightskip}{0pt plus 5cm}BiblioIsisDb::backend (\$ {\em method} = {\ttfamily 'count'}, \/  \$ {\em args} = {\ttfamily NULL})}}
+\subsubsection[{backend}]{\setlength{\rightskip}{0pt plus 5cm}BiblioIsisDb::backend (
+\begin{DoxyParamCaption}
+\item[{\$}]{ method = {\ttfamily 'count'}, }
+\item[{\$}]{ args = {\ttfamily NULL}}
+\end{DoxyParamCaption}
+)}}
 \label{classBiblioIsisDb_ad5704f5c9454ac053e66a489797ba221}
 Send requests to the perl backend.
 
@@ -96,7 +105,11 @@ Backend return value.
 \hypertarget{classBiblioIsisDb_a2b6fd7b7316f63ac5649ebf3947c4fae}{
 \index{BiblioIsisDb@{BiblioIsisDb}!charset@{charset}}
 \index{charset@{charset}!BiblioIsisDb@{BiblioIsisDb}}
-\subsubsection[{charset}]{\setlength{\rightskip}{0pt plus 5cm}BiblioIsisDb::charset (\&\$ {\em data})}}
+\subsubsection[{charset}]{\setlength{\rightskip}{0pt plus 5cm}BiblioIsisDb::charset (
+\begin{DoxyParamCaption}
+\item[{\&\$}]{ data}
+\end{DoxyParamCaption}
+)}}
 \label{classBiblioIsisDb_a2b6fd7b7316f63ac5649ebf3947c4fae}
 Charset conversion.
 
@@ -111,7 +124,12 @@ String converted to UTF-\/8.
 \hypertarget{classBiblioIsisDb_a929467f1907d3aeaeebe493f0c188c5b}{
 \index{BiblioIsisDb@{BiblioIsisDb}!check@{check}}
 \index{check@{check}!BiblioIsisDb@{BiblioIsisDb}}
-\subsubsection[{check}]{\setlength{\rightskip}{0pt plus 5cm}static BiblioIsisDb::check (\$ {\em schema}, \/  \$ {\em section} = {\ttfamily NULL})\hspace{0.3cm}{\ttfamily  \mbox{[}static\mbox{]}}}}
+\subsubsection[{check}]{\setlength{\rightskip}{0pt plus 5cm}static BiblioIsisDb::check (
+\begin{DoxyParamCaption}
+\item[{\$}]{ schema, }
+\item[{\$}]{ section = {\ttfamily NULL}}
+\end{DoxyParamCaption}
+)\hspace{0.3cm}{\ttfamily  \mbox{[}static\mbox{]}}}}
 \label{classBiblioIsisDb_a929467f1907d3aeaeebe493f0c188c5b}
 Check configuration.
 
@@ -125,7 +143,11 @@ Implements \hyperlink{interfaceIsisDb_af681b8f990b579f1835aa7ba4c83f1b8}{IsisDb}
 \hypertarget{classBiblioIsisDb_ab6b0a977c066c25c6bdca5c1d3a083e8}{
 \index{BiblioIsisDb@{BiblioIsisDb}!entries@{entries}}
 \index{entries@{entries}!BiblioIsisDb@{BiblioIsisDb}}
-\subsubsection[{entries}]{\setlength{\rightskip}{0pt plus 5cm}BiblioIsisDb::entries ()}}
+\subsubsection[{entries}]{\setlength{\rightskip}{0pt plus 5cm}BiblioIsisDb::entries (
+\begin{DoxyParamCaption}
+{}
+\end{DoxyParamCaption}
+)}}
 \label{classBiblioIsisDb_ab6b0a977c066c25c6bdca5c1d3a083e8}
 Return number of entries in the database.
 
@@ -139,7 +161,11 @@ Implements \hyperlink{interfaceIsisDb_a86f38eca2b6d0835b60770d8a4e511ff}{IsisDb}
 \hypertarget{classBiblioIsisDb_a8e76b289b9e3a9893b9469094753d2bc}{
 \index{BiblioIsisDb@{BiblioIsisDb}!example@{example}}
 \index{example@{example}!BiblioIsisDb@{BiblioIsisDb}}
-\subsubsection[{example}]{\setlength{\rightskip}{0pt plus 5cm}BiblioIsisDb::example ()}}
+\subsubsection[{example}]{\setlength{\rightskip}{0pt plus 5cm}BiblioIsisDb::example (
+\begin{DoxyParamCaption}
+{}
+\end{DoxyParamCaption}
+)}}
 \label{classBiblioIsisDb_a8e76b289b9e3a9893b9469094753d2bc}
 Return an example schema.
 
@@ -153,7 +179,11 @@ Implements \hyperlink{interfaceIsisDb_a857c10d90da64067efa17afb2f32edb6}{IsisDb}
 \hypertarget{classBiblioIsisDb_a73d5d998f9ab7e410c5f71f65e83948b}{
 \index{BiblioIsisDb@{BiblioIsisDb}!has\_\-subfields@{has\_\-subfields}}
 \index{has\_\-subfields@{has\_\-subfields}!BiblioIsisDb@{BiblioIsisDb}}
-\subsubsection[{has\_\-subfields}]{\setlength{\rightskip}{0pt plus 5cm}BiblioIsisDb::has\_\-subfields (\$ {\em key})}}
+\subsubsection[{has\_\-subfields}]{\setlength{\rightskip}{0pt plus 5cm}BiblioIsisDb::has\_\-subfields (
+\begin{DoxyParamCaption}
+\item[{\$}]{ key}
+\end{DoxyParamCaption}
+)}}
 \label{classBiblioIsisDb_a73d5d998f9ab7e410c5f71f65e83948b}
 Checks whether a field has subfields.
 
@@ -166,7 +196,12 @@ True if has subfields, false otherwise.
 \hypertarget{classBiblioIsisDb_aa86380f9e66ea8f175c50675d1fe0a88}{
 \index{BiblioIsisDb@{BiblioIsisDb}!is\_\-repetitive@{is\_\-repetitive}}
 \index{is\_\-repetitive@{is\_\-repetitive}!BiblioIsisDb@{BiblioIsisDb}}
-\subsubsection[{is\_\-repetitive}]{\setlength{\rightskip}{0pt plus 5cm}BiblioIsisDb::is\_\-repetitive (\$ {\em field}, \/  \$ {\em value})}}
+\subsubsection[{is\_\-repetitive}]{\setlength{\rightskip}{0pt plus 5cm}BiblioIsisDb::is\_\-repetitive (
+\begin{DoxyParamCaption}
+\item[{\$}]{ field, }
+\item[{\$}]{ value}
+\end{DoxyParamCaption}
+)}}
 \label{classBiblioIsisDb_aa86380f9e66ea8f175c50675d1fe0a88}
 Deals with repetition.
 
@@ -181,7 +216,11 @@ True if repetitive, false otherwise.
 \hypertarget{classBiblioIsisDb_a286fb16de5797785d28021068efca561}{
 \index{BiblioIsisDb@{BiblioIsisDb}!logger@{logger}}
 \index{logger@{logger}!BiblioIsisDb@{BiblioIsisDb}}
-\subsubsection[{logger}]{\setlength{\rightskip}{0pt plus 5cm}BiblioIsisDb::logger (\$ {\em message})}}
+\subsubsection[{logger}]{\setlength{\rightskip}{0pt plus 5cm}BiblioIsisDb::logger (
+\begin{DoxyParamCaption}
+\item[{\$}]{ message}
+\end{DoxyParamCaption}
+)}}
 \label{classBiblioIsisDb_a286fb16de5797785d28021068efca561}
 Class logger.
 
@@ -191,7 +230,12 @@ Class logger.
 \hypertarget{classBiblioIsisDb_a808cdbc0d4c8f62a1465e74064f4422f}{
 \index{BiblioIsisDb@{BiblioIsisDb}!read@{read}}
 \index{read@{read}!BiblioIsisDb@{BiblioIsisDb}}
-\subsubsection[{read}]{\setlength{\rightskip}{0pt plus 5cm}BiblioIsisDb::read (\$ {\em id}, \/  \$ {\em method} = {\ttfamily 'fetch'})}}
+\subsubsection[{read}]{\setlength{\rightskip}{0pt plus 5cm}BiblioIsisDb::read (
+\begin{DoxyParamCaption}
+\item[{\$}]{ id, }
+\item[{\$}]{ method = {\ttfamily 'fetch'}}
+\end{DoxyParamCaption}
+)}}
 \label{classBiblioIsisDb_a808cdbc0d4c8f62a1465e74064f4422f}
 Read an entry.
 
@@ -204,7 +248,12 @@ Read an entry.
 \hypertarget{classBiblioIsisDb_a04089d61ce04b18aa6a78c94ca02edb9}{
 \index{BiblioIsisDb@{BiblioIsisDb}!repetition@{repetition}}
 \index{repetition@{repetition}!BiblioIsisDb@{BiblioIsisDb}}
-\subsubsection[{repetition}]{\setlength{\rightskip}{0pt plus 5cm}BiblioIsisDb::repetition (\$ {\em key}, \/  \$ {\em value})}}
+\subsubsection[{repetition}]{\setlength{\rightskip}{0pt plus 5cm}BiblioIsisDb::repetition (
+\begin{DoxyParamCaption}
+\item[{\$}]{ key, }
+\item[{\$}]{ value}
+\end{DoxyParamCaption}
+)}}
 \label{classBiblioIsisDb_a04089d61ce04b18aa6a78c94ca02edb9}
 Deals with repetition.
 
@@ -219,7 +268,13 @@ The value according to the repetition config.
 \hypertarget{classBiblioIsisDb_a450e26ae0b7f4967d8e25c9a3d023c75}{
 \index{BiblioIsisDb@{BiblioIsisDb}!subfields@{subfields}}
 \index{subfields@{subfields}!BiblioIsisDb@{BiblioIsisDb}}
-\subsubsection[{subfields}]{\setlength{\rightskip}{0pt plus 5cm}BiblioIsisDb::subfields (\$ {\em name}, \/  \$ {\em key}, \/  \$ {\em method})}}
+\subsubsection[{subfields}]{\setlength{\rightskip}{0pt plus 5cm}BiblioIsisDb::subfields (
+\begin{DoxyParamCaption}
+\item[{\$}]{ name, }
+\item[{\$}]{ key, }
+\item[{\$}]{ method}
+\end{DoxyParamCaption}
+)}}
 \label{classBiblioIsisDb_a450e26ae0b7f4967d8e25c9a3d023c75}
 Makes subfield substitution in a dataset.
 
@@ -232,7 +287,12 @@ Data with processed subfields.
 \hypertarget{classBiblioIsisDb_a2b08c6a7ba20f6f5eb07edb2b4a914c1}{
 \index{BiblioIsisDb@{BiblioIsisDb}!subfields\_\-from\_\-fetch@{subfields\_\-from\_\-fetch}}
 \index{subfields\_\-from\_\-fetch@{subfields\_\-from\_\-fetch}!BiblioIsisDb@{BiblioIsisDb}}
-\subsubsection[{subfields\_\-from\_\-fetch}]{\setlength{\rightskip}{0pt plus 5cm}BiblioIsisDb::subfields\_\-from\_\-fetch (\$ {\em name}, \/  \$ {\em key})}}
+\subsubsection[{subfields\_\-from\_\-fetch}]{\setlength{\rightskip}{0pt plus 5cm}BiblioIsisDb::subfields\_\-from\_\-fetch (
+\begin{DoxyParamCaption}
+\item[{\$}]{ name, }
+\item[{\$}]{ key}
+\end{DoxyParamCaption}
+)}}
 \label{classBiblioIsisDb_a2b08c6a7ba20f6f5eb07edb2b4a914c1}
 Subfield handling for data read by 'from\_\-fetch' method.
 
@@ -245,7 +305,12 @@ Data with processed subfields.
 \hypertarget{classBiblioIsisDb_a8c6a0081c5296a6db520e98998502ef7}{
 \index{BiblioIsisDb@{BiblioIsisDb}!subfields\_\-from\_\-to\_\-hash@{subfields\_\-from\_\-to\_\-hash}}
 \index{subfields\_\-from\_\-to\_\-hash@{subfields\_\-from\_\-to\_\-hash}!BiblioIsisDb@{BiblioIsisDb}}
-\subsubsection[{subfields\_\-from\_\-to\_\-hash}]{\setlength{\rightskip}{0pt plus 5cm}BiblioIsisDb::subfields\_\-from\_\-to\_\-hash (\$ {\em name}, \/  \$ {\em key})}}
+\subsubsection[{subfields\_\-from\_\-to\_\-hash}]{\setlength{\rightskip}{0pt plus 5cm}BiblioIsisDb::subfields\_\-from\_\-to\_\-hash (
+\begin{DoxyParamCaption}
+\item[{\$}]{ name, }
+\item[{\$}]{ key}
+\end{DoxyParamCaption}
+)}}
 \label{classBiblioIsisDb_a8c6a0081c5296a6db520e98998502ef7}
 Subfield handling for data read by 'to\_\-hash' method. This method is not fully supported and therefore not recommended.
 
@@ -260,7 +325,12 @@ Data with processed subfields.
 \hypertarget{classBiblioIsisDb_af0be305b211b96dcb4aeb8452c8331a9}{
 \index{BiblioIsisDb@{BiblioIsisDb}!subfields\_\-switch@{subfields\_\-switch}}
 \index{subfields\_\-switch@{subfields\_\-switch}!BiblioIsisDb@{BiblioIsisDb}}
-\subsubsection[{subfields\_\-switch}]{\setlength{\rightskip}{0pt plus 5cm}BiblioIsisDb::subfields\_\-switch (\$ {\em key}, \/  \&\$ {\em value})}}
+\subsubsection[{subfields\_\-switch}]{\setlength{\rightskip}{0pt plus 5cm}BiblioIsisDb::subfields\_\-switch (
+\begin{DoxyParamCaption}
+\item[{\$}]{ key, }
+\item[{\&\$}]{ value}
+\end{DoxyParamCaption}
+)}}
 \label{classBiblioIsisDb_af0be305b211b96dcb4aeb8452c8331a9}
 Switch keys on subfields.
 
@@ -270,7 +340,12 @@ Switch keys on subfields.
 \hypertarget{classBiblioIsisDb_a34483b463d81ba1d8031576b5735efbc}{
 \index{BiblioIsisDb@{BiblioIsisDb}!tag@{tag}}
 \index{tag@{tag}!BiblioIsisDb@{BiblioIsisDb}}
-\subsubsection[{tag}]{\setlength{\rightskip}{0pt plus 5cm}BiblioIsisDb::tag (\$ {\em results}, \/  \$ {\em method} = {\ttfamily 'fetch'})}}
+\subsubsection[{tag}]{\setlength{\rightskip}{0pt plus 5cm}BiblioIsisDb::tag (
+\begin{DoxyParamCaption}
+\item[{\$}]{ results, }
+\item[{\$}]{ method = {\ttfamily 'fetch'}}
+\end{DoxyParamCaption}
+)}}
 \label{classBiblioIsisDb_a34483b463d81ba1d8031576b5735efbc}
 Tag results of a db query.
 
-- 
cgit v1.2.3

