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/classIsisItemIterator.tex | 38 +++++++++++++++++++++++++++++++------ 1 file changed, 32 insertions(+), 6 deletions(-) (limited to 'doc/latex/classIsisItemIterator.tex') diff --git a/doc/latex/classIsisItemIterator.tex b/doc/latex/classIsisItemIterator.tex index ba95027..617feca 100644 --- a/doc/latex/classIsisItemIterator.tex +++ b/doc/latex/classIsisItemIterator.tex @@ -26,7 +26,13 @@ Isis field iterator. Iterates over a field for each result row. \hypertarget{classIsisItemIterator_a6ee7fe126baaffa77ad2cf177fefc46a}{ \index{IsisItemIterator@{IsisItemIterator}!\_\-\_\-construct@{\_\-\_\-construct}} \index{\_\-\_\-construct@{\_\-\_\-construct}!IsisItemIterator@{IsisItemIterator}} -\subsubsection[{\_\-\_\-construct}]{\setlength{\rightskip}{0pt plus 5cm}IsisItemIterator::\_\-\_\-construct (\$ {\em class}, \/ \$ {\em field}, \/ \$ {\em main} = {\ttfamily false})}} +\subsubsection[{\_\-\_\-construct}]{\setlength{\rightskip}{0pt plus 5cm}IsisItemIterator::\_\-\_\-construct ( +\begin{DoxyParamCaption} +\item[{\$}]{ class, } +\item[{\$}]{ field, } +\item[{\$}]{ main = {\ttfamily false}} +\end{DoxyParamCaption} +)}} \label{classIsisItemIterator_a6ee7fe126baaffa77ad2cf177fefc46a} Constructor. @@ -39,27 +45,47 @@ Constructor. \hypertarget{classIsisItemIterator_a3f602399a600d7b95d23b87111d0e72b}{ \index{IsisItemIterator@{IsisItemIterator}!current@{current}} \index{current@{current}!IsisItemIterator@{IsisItemIterator}} -\subsubsection[{current}]{\setlength{\rightskip}{0pt plus 5cm}IsisItemIterator::current ()}} +\subsubsection[{current}]{\setlength{\rightskip}{0pt plus 5cm}IsisItemIterator::current ( +\begin{DoxyParamCaption} +{} +\end{DoxyParamCaption} +)}} \label{classIsisItemIterator_a3f602399a600d7b95d23b87111d0e72b} Return the current element. \hypertarget{classIsisItemIterator_ab51757f546b7d9efb9decd701a38b8b5}{ \index{IsisItemIterator@{IsisItemIterator}!key@{key}} \index{key@{key}!IsisItemIterator@{IsisItemIterator}} -\subsubsection[{key}]{\setlength{\rightskip}{0pt plus 5cm}IsisItemIterator::key ()}} +\subsubsection[{key}]{\setlength{\rightskip}{0pt plus 5cm}IsisItemIterator::key ( +\begin{DoxyParamCaption} +{} +\end{DoxyParamCaption} +)}} \label{classIsisItemIterator_ab51757f546b7d9efb9decd701a38b8b5} Return the key of the current element. \hypertarget{classIsisItemIterator_a17c6a2e50a0ca67feb92f4ffc4cbec23}{ \index{IsisItemIterator@{IsisItemIterator}!next@{next}} \index{next@{next}!IsisItemIterator@{IsisItemIterator}} -\subsubsection[{next}]{\setlength{\rightskip}{0pt plus 5cm}IsisItemIterator::next ()}} +\subsubsection[{next}]{\setlength{\rightskip}{0pt plus 5cm}IsisItemIterator::next ( +\begin{DoxyParamCaption} +{} +\end{DoxyParamCaption} +)}} \label{classIsisItemIterator_a17c6a2e50a0ca67feb92f4ffc4cbec23} Move forward to next element. \hypertarget{classIsisItemIterator_ab87a4387a9fd745366ccf8e138a9f60c}{ \index{IsisItemIterator@{IsisItemIterator}!rewind@{rewind}} \index{rewind@{rewind}!IsisItemIterator@{IsisItemIterator}} -\subsubsection[{rewind}]{\setlength{\rightskip}{0pt plus 5cm}IsisItemIterator::rewind ()}} +\subsubsection[{rewind}]{\setlength{\rightskip}{0pt plus 5cm}IsisItemIterator::rewind ( +\begin{DoxyParamCaption} +{} +\end{DoxyParamCaption} +)}} \label{classIsisItemIterator_ab87a4387a9fd745366ccf8e138a9f60c} Rewind the Iterator to the first element. \hypertarget{classIsisItemIterator_aacea6ed6fd269ef1549ce86820da8b3b}{ \index{IsisItemIterator@{IsisItemIterator}!valid@{valid}} \index{valid@{valid}!IsisItemIterator@{IsisItemIterator}} -\subsubsection[{valid}]{\setlength{\rightskip}{0pt plus 5cm}IsisItemIterator::valid ()}} +\subsubsection[{valid}]{\setlength{\rightskip}{0pt plus 5cm}IsisItemIterator::valid ( +\begin{DoxyParamCaption} +{} +\end{DoxyParamCaption} +)}} \label{classIsisItemIterator_aacea6ed6fd269ef1549ce86820da8b3b} Check if there is a current element after calls to \hyperlink{classIsisItemIterator_ab87a4387a9fd745366ccf8e138a9f60c}{rewind()} or \hyperlink{classIsisItemIterator_a17c6a2e50a0ca67feb92f4ffc4cbec23}{next()}. -- cgit v1.2.3