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/classIsisEntryIterator.tex | 37 ++++++++++++++++++++++++++++++------ 1 file changed, 31 insertions(+), 6 deletions(-) (limited to 'doc/latex/classIsisEntryIterator.tex') diff --git a/doc/latex/classIsisEntryIterator.tex b/doc/latex/classIsisEntryIterator.tex index 07f9418..f216b88 100644 --- a/doc/latex/classIsisEntryIterator.tex +++ b/doc/latex/classIsisEntryIterator.tex @@ -26,7 +26,12 @@ Isis entry iterator. Iterates over all entries in the database. \hypertarget{classIsisEntryIterator_a056fcc7d817523faf1fb033fa9f8ad6e}{ \index{IsisEntryIterator@{IsisEntryIterator}!\_\-\_\-construct@{\_\-\_\-construct}} \index{\_\-\_\-construct@{\_\-\_\-construct}!IsisEntryIterator@{IsisEntryIterator}} -\subsubsection[{\_\-\_\-construct}]{\setlength{\rightskip}{0pt plus 5cm}IsisEntryIterator::\_\-\_\-construct (\$ {\em class}, \/ \$ {\em entry} = {\ttfamily 1})}} +\subsubsection[{\_\-\_\-construct}]{\setlength{\rightskip}{0pt plus 5cm}IsisEntryIterator::\_\-\_\-construct ( +\begin{DoxyParamCaption} +\item[{\$}]{ class, } +\item[{\$}]{ entry = {\ttfamily 1}} +\end{DoxyParamCaption} +)}} \label{classIsisEntryIterator_a056fcc7d817523faf1fb033fa9f8ad6e} Constructor. @@ -39,27 +44,47 @@ Constructor. \hypertarget{classIsisEntryIterator_ac482f43403fc4d2e1b620fb4e0f6797f}{ \index{IsisEntryIterator@{IsisEntryIterator}!current@{current}} \index{current@{current}!IsisEntryIterator@{IsisEntryIterator}} -\subsubsection[{current}]{\setlength{\rightskip}{0pt plus 5cm}IsisEntryIterator::current ()}} +\subsubsection[{current}]{\setlength{\rightskip}{0pt plus 5cm}IsisEntryIterator::current ( +\begin{DoxyParamCaption} +{} +\end{DoxyParamCaption} +)}} \label{classIsisEntryIterator_ac482f43403fc4d2e1b620fb4e0f6797f} Return the current element. \hypertarget{classIsisEntryIterator_a4a740dacedb86023ece4561092c33a65}{ \index{IsisEntryIterator@{IsisEntryIterator}!key@{key}} \index{key@{key}!IsisEntryIterator@{IsisEntryIterator}} -\subsubsection[{key}]{\setlength{\rightskip}{0pt plus 5cm}IsisEntryIterator::key ()}} +\subsubsection[{key}]{\setlength{\rightskip}{0pt plus 5cm}IsisEntryIterator::key ( +\begin{DoxyParamCaption} +{} +\end{DoxyParamCaption} +)}} \label{classIsisEntryIterator_a4a740dacedb86023ece4561092c33a65} Return the key of the current element. \hypertarget{classIsisEntryIterator_a2d1d0fe5d3c22d1720e93e03952b877d}{ \index{IsisEntryIterator@{IsisEntryIterator}!next@{next}} \index{next@{next}!IsisEntryIterator@{IsisEntryIterator}} -\subsubsection[{next}]{\setlength{\rightskip}{0pt plus 5cm}IsisEntryIterator::next ()}} +\subsubsection[{next}]{\setlength{\rightskip}{0pt plus 5cm}IsisEntryIterator::next ( +\begin{DoxyParamCaption} +{} +\end{DoxyParamCaption} +)}} \label{classIsisEntryIterator_a2d1d0fe5d3c22d1720e93e03952b877d} Move forward to next element. \hypertarget{classIsisEntryIterator_a985e88cdfb69b42e3389f24c08b2404a}{ \index{IsisEntryIterator@{IsisEntryIterator}!rewind@{rewind}} \index{rewind@{rewind}!IsisEntryIterator@{IsisEntryIterator}} -\subsubsection[{rewind}]{\setlength{\rightskip}{0pt plus 5cm}IsisEntryIterator::rewind ()}} +\subsubsection[{rewind}]{\setlength{\rightskip}{0pt plus 5cm}IsisEntryIterator::rewind ( +\begin{DoxyParamCaption} +{} +\end{DoxyParamCaption} +)}} \label{classIsisEntryIterator_a985e88cdfb69b42e3389f24c08b2404a} Rewind the Iterator to the first element. \hypertarget{classIsisEntryIterator_aff9e54b112cc728b7cd6cf00c0359c49}{ \index{IsisEntryIterator@{IsisEntryIterator}!valid@{valid}} \index{valid@{valid}!IsisEntryIterator@{IsisEntryIterator}} -\subsubsection[{valid}]{\setlength{\rightskip}{0pt plus 5cm}IsisEntryIterator::valid ()}} +\subsubsection[{valid}]{\setlength{\rightskip}{0pt plus 5cm}IsisEntryIterator::valid ( +\begin{DoxyParamCaption} +{} +\end{DoxyParamCaption} +)}} \label{classIsisEntryIterator_aff9e54b112cc728b7cd6cf00c0359c49} Check if there is a current element after calls to \hyperlink{classIsisEntryIterator_a985e88cdfb69b42e3389f24c08b2404a}{rewind()} or \hyperlink{classIsisEntryIterator_a2d1d0fe5d3c22d1720e93e03952b877d}{next()}. -- cgit v1.2.3