aboutsummaryrefslogtreecommitdiff
path: root/doc/latex/classIsisSubfieldIterator.tex
diff options
context:
space:
mode:
authorSilvio <silvio@devlet.com.br>2011-02-22 10:37:10 -0300
committerSilvio Rhatto <silvio@devlet.com.br>2011-02-22 10:37:10 -0300
commitf253764c93f49dcdfe01b9e3f4d2a1352406b8f1 (patch)
treeb6a4d1d70cdb9cdfca0ec5984a458be1431313f7 /doc/latex/classIsisSubfieldIterator.tex
parent8b55b69339146f0b03b01dd1c12501754cbd9de0 (diff)
downloadcinisis-f253764c93f49dcdfe01b9e3f4d2a1352406b8f1.tar.gz
cinisis-f253764c93f49dcdfe01b9e3f4d2a1352406b8f1.tar.bz2
Documentation update
Diffstat (limited to 'doc/latex/classIsisSubfieldIterator.tex')
-rw-r--r--doc/latex/classIsisSubfieldIterator.tex38
1 files changed, 32 insertions, 6 deletions
diff --git a/doc/latex/classIsisSubfieldIterator.tex b/doc/latex/classIsisSubfieldIterator.tex
index 9f2f193..2fea9e8 100644
--- a/doc/latex/classIsisSubfieldIterator.tex
+++ b/doc/latex/classIsisSubfieldIterator.tex
@@ -26,7 +26,13 @@ Isis subfield iterator. Iterates over subfields for each result row.
\hypertarget{classIsisSubfieldIterator_adc5472ca67d20defcab9eba45975dc29}{
\index{IsisSubfieldIterator@{IsisSubfieldIterator}!\_\-\_\-construct@{\_\-\_\-construct}}
\index{\_\-\_\-construct@{\_\-\_\-construct}!IsisSubfieldIterator@{IsisSubfieldIterator}}
-\subsubsection[{\_\-\_\-construct}]{\setlength{\rightskip}{0pt plus 5cm}IsisSubfieldIterator::\_\-\_\-construct (\$ {\em class}, \/ \$ {\em field}, \/ \$ {\em main} = {\ttfamily false})}}
+\subsubsection[{\_\-\_\-construct}]{\setlength{\rightskip}{0pt plus 5cm}IsisSubfieldIterator::\_\-\_\-construct (
+\begin{DoxyParamCaption}
+\item[{\$}]{ class, }
+\item[{\$}]{ field, }
+\item[{\$}]{ main = {\ttfamily false}}
+\end{DoxyParamCaption}
+)}}
\label{classIsisSubfieldIterator_adc5472ca67d20defcab9eba45975dc29}
Constructor.
@@ -39,27 +45,47 @@ Constructor.
\hypertarget{classIsisSubfieldIterator_a7c31b7e8db31e1465d29fb58b2448bd8}{
\index{IsisSubfieldIterator@{IsisSubfieldIterator}!current@{current}}
\index{current@{current}!IsisSubfieldIterator@{IsisSubfieldIterator}}
-\subsubsection[{current}]{\setlength{\rightskip}{0pt plus 5cm}IsisSubfieldIterator::current ()}}
+\subsubsection[{current}]{\setlength{\rightskip}{0pt plus 5cm}IsisSubfieldIterator::current (
+\begin{DoxyParamCaption}
+{}
+\end{DoxyParamCaption}
+)}}
\label{classIsisSubfieldIterator_a7c31b7e8db31e1465d29fb58b2448bd8}
Return the current element. \hypertarget{classIsisSubfieldIterator_a4ee62ad436a7c4ec1dac0c0c5d2a2c85}{
\index{IsisSubfieldIterator@{IsisSubfieldIterator}!key@{key}}
\index{key@{key}!IsisSubfieldIterator@{IsisSubfieldIterator}}
-\subsubsection[{key}]{\setlength{\rightskip}{0pt plus 5cm}IsisSubfieldIterator::key ()}}
+\subsubsection[{key}]{\setlength{\rightskip}{0pt plus 5cm}IsisSubfieldIterator::key (
+\begin{DoxyParamCaption}
+{}
+\end{DoxyParamCaption}
+)}}
\label{classIsisSubfieldIterator_a4ee62ad436a7c4ec1dac0c0c5d2a2c85}
Return the key of the current element. \hypertarget{classIsisSubfieldIterator_a74363e3dbfbde6d409b8ba3b70fc9371}{
\index{IsisSubfieldIterator@{IsisSubfieldIterator}!next@{next}}
\index{next@{next}!IsisSubfieldIterator@{IsisSubfieldIterator}}
-\subsubsection[{next}]{\setlength{\rightskip}{0pt plus 5cm}IsisSubfieldIterator::next ()}}
+\subsubsection[{next}]{\setlength{\rightskip}{0pt plus 5cm}IsisSubfieldIterator::next (
+\begin{DoxyParamCaption}
+{}
+\end{DoxyParamCaption}
+)}}
\label{classIsisSubfieldIterator_a74363e3dbfbde6d409b8ba3b70fc9371}
Move forward to next element. \hypertarget{classIsisSubfieldIterator_a971b36317fab4fc07573f215a118fb40}{
\index{IsisSubfieldIterator@{IsisSubfieldIterator}!rewind@{rewind}}
\index{rewind@{rewind}!IsisSubfieldIterator@{IsisSubfieldIterator}}
-\subsubsection[{rewind}]{\setlength{\rightskip}{0pt plus 5cm}IsisSubfieldIterator::rewind ()}}
+\subsubsection[{rewind}]{\setlength{\rightskip}{0pt plus 5cm}IsisSubfieldIterator::rewind (
+\begin{DoxyParamCaption}
+{}
+\end{DoxyParamCaption}
+)}}
\label{classIsisSubfieldIterator_a971b36317fab4fc07573f215a118fb40}
Rewind the Iterator to the first element. \hypertarget{classIsisSubfieldIterator_a1934438bfdfa1827e6bcc71d3c90f2db}{
\index{IsisSubfieldIterator@{IsisSubfieldIterator}!valid@{valid}}
\index{valid@{valid}!IsisSubfieldIterator@{IsisSubfieldIterator}}
-\subsubsection[{valid}]{\setlength{\rightskip}{0pt plus 5cm}IsisSubfieldIterator::valid ()}}
+\subsubsection[{valid}]{\setlength{\rightskip}{0pt plus 5cm}IsisSubfieldIterator::valid (
+\begin{DoxyParamCaption}
+{}
+\end{DoxyParamCaption}
+)}}
\label{classIsisSubfieldIterator_a1934438bfdfa1827e6bcc71d3c90f2db}
Check if there is a current element after calls to \hyperlink{classIsisSubfieldIterator_a971b36317fab4fc07573f215a118fb40}{rewind()} or \hyperlink{classIsisSubfieldIterator_a74363e3dbfbde6d409b8ba3b70fc9371}{next()}.