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/classIsisFinder.tex | 60 +++++++++++++++++++++++++++++++++++++------ 1 file changed, 52 insertions(+), 8 deletions(-) (limited to 'doc/latex/classIsisFinder.tex') diff --git a/doc/latex/classIsisFinder.tex b/doc/latex/classIsisFinder.tex index a7e83ea..68b4588 100644 --- a/doc/latex/classIsisFinder.tex +++ b/doc/latex/classIsisFinder.tex @@ -5,7 +5,7 @@ Inheritance diagram for IsisFinder:\begin{figure}[H] \begin{center} \leavevmode -\includegraphics[height=5cm]{classIsisFinder} +\includegraphics[height=5.000000cm]{classIsisFinder} \end{center} \end{figure} \subsection*{Public Member Functions} @@ -34,7 +34,12 @@ Provides Isis Database search methods. \hypertarget{classIsisFinder_a41410b18c4462c05ac669e4ee889d8a7}{ \index{IsisFinder@{IsisFinder}!hasSubfieldInRows@{hasSubfieldInRows}} \index{hasSubfieldInRows@{hasSubfieldInRows}!IsisFinder@{IsisFinder}} -\subsubsection[{hasSubfieldInRows}]{\setlength{\rightskip}{0pt plus 5cm}IsisFinder::hasSubfieldInRows (\$ {\em field}, \/ \$ {\em subfield})}} +\subsubsection[{hasSubfieldInRows}]{\setlength{\rightskip}{0pt plus 5cm}IsisFinder::hasSubfieldInRows ( +\begin{DoxyParamCaption} +\item[{\$}]{ field, } +\item[{\$}]{ subfield} +\end{DoxyParamCaption} +)}} \label{classIsisFinder_a41410b18c4462c05ac669e4ee889d8a7} Check if a field result has a given subfield. @@ -47,7 +52,14 @@ True if result has the subfield, false otherwise. \hypertarget{classIsisFinder_ab35a9bb21e83df846b6ff57bcbe117ae}{ \index{IsisFinder@{IsisFinder}!matchMainItem@{matchMainItem}} \index{matchMainItem@{matchMainItem}!IsisFinder@{IsisFinder}} -\subsubsection[{matchMainItem}]{\setlength{\rightskip}{0pt plus 5cm}IsisFinder::matchMainItem (\$ {\em field}, \/ \$ {\em row}, \/ \$ {\em search}, \/ \$ {\em match})}} +\subsubsection[{matchMainItem}]{\setlength{\rightskip}{0pt plus 5cm}IsisFinder::matchMainItem ( +\begin{DoxyParamCaption} +\item[{\$}]{ field, } +\item[{\$}]{ row, } +\item[{\$}]{ search, } +\item[{\$}]{ match} +\end{DoxyParamCaption} +)}} \label{classIsisFinder_ab35a9bb21e83df846b6ff57bcbe117ae} Check if a main item match a given value. @@ -60,7 +72,15 @@ True if match, false otherwise. \hypertarget{classIsisFinder_a20539e44cfc30ca3897e174781c4b26c}{ \index{IsisFinder@{IsisFinder}!matchSubfield@{matchSubfield}} \index{matchSubfield@{matchSubfield}!IsisFinder@{IsisFinder}} -\subsubsection[{matchSubfield}]{\setlength{\rightskip}{0pt plus 5cm}IsisFinder::matchSubfield (\$ {\em field}, \/ \$ {\em subfield}, \/ \$ {\em row}, \/ \$ {\em search}, \/ \$ {\em match})}} +\subsubsection[{matchSubfield}]{\setlength{\rightskip}{0pt plus 5cm}IsisFinder::matchSubfield ( +\begin{DoxyParamCaption} +\item[{\$}]{ field, } +\item[{\$}]{ subfield, } +\item[{\$}]{ row, } +\item[{\$}]{ search, } +\item[{\$}]{ match} +\end{DoxyParamCaption} +)}} \label{classIsisFinder_a20539e44cfc30ca3897e174781c4b26c} Check if a subfield match a given value. @@ -73,7 +93,12 @@ True if match, false otherwise. \hypertarget{classIsisFinder_a7d708e281bea35ee38f5875c8f2cad8d}{ \index{IsisFinder@{IsisFinder}!nextField@{nextField}} \index{nextField@{nextField}!IsisFinder@{IsisFinder}} -\subsubsection[{nextField}]{\setlength{\rightskip}{0pt plus 5cm}IsisFinder::nextField (\$ {\em field}, \/ \$ {\em entry} = {\ttfamily 1})}} +\subsubsection[{nextField}]{\setlength{\rightskip}{0pt plus 5cm}IsisFinder::nextField ( +\begin{DoxyParamCaption} +\item[{\$}]{ field, } +\item[{\$}]{ entry = {\ttfamily 1}} +\end{DoxyParamCaption} +)}} \label{classIsisFinder_a7d708e281bea35ee38f5875c8f2cad8d} Find the next occurrence of a field. @@ -86,7 +111,12 @@ Next occurrence. \hypertarget{classIsisFinder_ac4e3a8f45995cbf940b3f2899b71bd1e}{ \index{IsisFinder@{IsisFinder}!nextRepetition@{nextRepetition}} \index{nextRepetition@{nextRepetition}!IsisFinder@{IsisFinder}} -\subsubsection[{nextRepetition}]{\setlength{\rightskip}{0pt plus 5cm}IsisFinder::nextRepetition (\$ {\em field}, \/ \$ {\em entry} = {\ttfamily 1})}} +\subsubsection[{nextRepetition}]{\setlength{\rightskip}{0pt plus 5cm}IsisFinder::nextRepetition ( +\begin{DoxyParamCaption} +\item[{\$}]{ field, } +\item[{\$}]{ entry = {\ttfamily 1}} +\end{DoxyParamCaption} +)}} \label{classIsisFinder_ac4e3a8f45995cbf940b3f2899b71bd1e} Find the next repetition of a field. @@ -99,7 +129,15 @@ Next repetition entry and result. \hypertarget{classIsisFinder_af965ba4acae18aa61bc4a3242bcdadfc}{ \index{IsisFinder@{IsisFinder}!nextResult@{nextResult}} \index{nextResult@{nextResult}!IsisFinder@{IsisFinder}} -\subsubsection[{nextResult}]{\setlength{\rightskip}{0pt plus 5cm}IsisFinder::nextResult (\$ {\em field}, \/ \$ {\em item}, \/ \$ {\em search}, \/ \$ {\em entry} = {\ttfamily 1}, \/ \$ {\em match} = {\ttfamily TRUE})}} +\subsubsection[{nextResult}]{\setlength{\rightskip}{0pt plus 5cm}IsisFinder::nextResult ( +\begin{DoxyParamCaption} +\item[{\$}]{ field, } +\item[{\$}]{ item, } +\item[{\$}]{ search, } +\item[{\$}]{ entry = {\ttfamily 1}, } +\item[{\$}]{ match = {\ttfamily TRUE}} +\end{DoxyParamCaption} +)}} \label{classIsisFinder_af965ba4acae18aa61bc4a3242bcdadfc} Search the next match inside a result. @@ -109,7 +147,13 @@ Search the next match inside a result. \hypertarget{classIsisFinder_aa367980783d341197e003684a639ff1a}{ \index{IsisFinder@{IsisFinder}!nextSubfield@{nextSubfield}} \index{nextSubfield@{nextSubfield}!IsisFinder@{IsisFinder}} -\subsubsection[{nextSubfield}]{\setlength{\rightskip}{0pt plus 5cm}IsisFinder::nextSubfield (\$ {\em field}, \/ \$ {\em subfield}, \/ \$ {\em entry} = {\ttfamily 1})}} +\subsubsection[{nextSubfield}]{\setlength{\rightskip}{0pt plus 5cm}IsisFinder::nextSubfield ( +\begin{DoxyParamCaption} +\item[{\$}]{ field, } +\item[{\$}]{ subfield, } +\item[{\$}]{ entry = {\ttfamily 1}} +\end{DoxyParamCaption} +)}} \label{classIsisFinder_aa367980783d341197e003684a639ff1a} Find the next occurrence of a subfield. -- cgit v1.2.3