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/classIsisValueIterator.tex | 37 ++++++++++++++++++++++++++++++------ 1 file changed, 31 insertions(+), 6 deletions(-) (limited to 'doc/latex/classIsisValueIterator.tex') diff --git a/doc/latex/classIsisValueIterator.tex b/doc/latex/classIsisValueIterator.tex index 3447da2..9c4a26d 100644 --- a/doc/latex/classIsisValueIterator.tex +++ b/doc/latex/classIsisValueIterator.tex @@ -26,7 +26,12 @@ Isis value iterator. Iterates over all values for each result row. \hypertarget{classIsisValueIterator_a4b5811fff950f830cbba2da40dfac497}{ \index{IsisValueIterator@{IsisValueIterator}!\_\-\_\-construct@{\_\-\_\-construct}} \index{\_\-\_\-construct@{\_\-\_\-construct}!IsisValueIterator@{IsisValueIterator}} -\subsubsection[{\_\-\_\-construct}]{\setlength{\rightskip}{0pt plus 5cm}IsisValueIterator::\_\-\_\-construct (\$ {\em class}, \/ \$ {\em field})}} +\subsubsection[{\_\-\_\-construct}]{\setlength{\rightskip}{0pt plus 5cm}IsisValueIterator::\_\-\_\-construct ( +\begin{DoxyParamCaption} +\item[{\$}]{ class, } +\item[{\$}]{ field} +\end{DoxyParamCaption} +)}} \label{classIsisValueIterator_a4b5811fff950f830cbba2da40dfac497} Constructor. @@ -39,27 +44,47 @@ Constructor. \hypertarget{classIsisValueIterator_ad7c6dd479b6129ba5bfc2f2003f6ca49}{ \index{IsisValueIterator@{IsisValueIterator}!current@{current}} \index{current@{current}!IsisValueIterator@{IsisValueIterator}} -\subsubsection[{current}]{\setlength{\rightskip}{0pt plus 5cm}IsisValueIterator::current ()}} +\subsubsection[{current}]{\setlength{\rightskip}{0pt plus 5cm}IsisValueIterator::current ( +\begin{DoxyParamCaption} +{} +\end{DoxyParamCaption} +)}} \label{classIsisValueIterator_ad7c6dd479b6129ba5bfc2f2003f6ca49} Return the current element. \hypertarget{classIsisValueIterator_a173b393699278fb2fb928e6bd2448a05}{ \index{IsisValueIterator@{IsisValueIterator}!key@{key}} \index{key@{key}!IsisValueIterator@{IsisValueIterator}} -\subsubsection[{key}]{\setlength{\rightskip}{0pt plus 5cm}IsisValueIterator::key ()}} +\subsubsection[{key}]{\setlength{\rightskip}{0pt plus 5cm}IsisValueIterator::key ( +\begin{DoxyParamCaption} +{} +\end{DoxyParamCaption} +)}} \label{classIsisValueIterator_a173b393699278fb2fb928e6bd2448a05} Return the key of the current element. \hypertarget{classIsisValueIterator_adc2fb9b1dd029cab4be0b48d6e0f11f9}{ \index{IsisValueIterator@{IsisValueIterator}!next@{next}} \index{next@{next}!IsisValueIterator@{IsisValueIterator}} -\subsubsection[{next}]{\setlength{\rightskip}{0pt plus 5cm}IsisValueIterator::next ()}} +\subsubsection[{next}]{\setlength{\rightskip}{0pt plus 5cm}IsisValueIterator::next ( +\begin{DoxyParamCaption} +{} +\end{DoxyParamCaption} +)}} \label{classIsisValueIterator_adc2fb9b1dd029cab4be0b48d6e0f11f9} Move forward to next element. \hypertarget{classIsisValueIterator_a175fe47671b335eecc591598053a6a88}{ \index{IsisValueIterator@{IsisValueIterator}!rewind@{rewind}} \index{rewind@{rewind}!IsisValueIterator@{IsisValueIterator}} -\subsubsection[{rewind}]{\setlength{\rightskip}{0pt plus 5cm}IsisValueIterator::rewind ()}} +\subsubsection[{rewind}]{\setlength{\rightskip}{0pt plus 5cm}IsisValueIterator::rewind ( +\begin{DoxyParamCaption} +{} +\end{DoxyParamCaption} +)}} \label{classIsisValueIterator_a175fe47671b335eecc591598053a6a88} Rewind the Iterator to the first element. \hypertarget{classIsisValueIterator_a7f6b3e0941c2110f1b2ba10ba2b87fb8}{ \index{IsisValueIterator@{IsisValueIterator}!valid@{valid}} \index{valid@{valid}!IsisValueIterator@{IsisValueIterator}} -\subsubsection[{valid}]{\setlength{\rightskip}{0pt plus 5cm}IsisValueIterator::valid ()}} +\subsubsection[{valid}]{\setlength{\rightskip}{0pt plus 5cm}IsisValueIterator::valid ( +\begin{DoxyParamCaption} +{} +\end{DoxyParamCaption} +)}} \label{classIsisValueIterator_a7f6b3e0941c2110f1b2ba10ba2b87fb8} Check if there is a current element after calls to \hyperlink{classIsisValueIterator_a175fe47671b335eecc591598053a6a88}{rewind()} or \hyperlink{classIsisValueIterator_adc2fb9b1dd029cab4be0b48d6e0f11f9}{next()}. -- cgit v1.2.3