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/classIsisReader.tex | 68 +++++++++++++++++++++++++++++++++++-------- 1 file changed, 56 insertions(+), 12 deletions(-) (limited to 'doc/latex/classIsisReader.tex') diff --git a/doc/latex/classIsisReader.tex b/doc/latex/classIsisReader.tex index 2ef116a..cfc98f7 100644 --- a/doc/latex/classIsisReader.tex +++ b/doc/latex/classIsisReader.tex @@ -5,7 +5,7 @@ Inheritance diagram for IsisReader:\begin{figure}[H] \begin{center} \leavevmode -\includegraphics[height=5cm]{classIsisReader} +\includegraphics[height=5.000000cm]{classIsisReader} \end{center} \end{figure} \subsection*{Public Member Functions} @@ -42,7 +42,11 @@ Provides basic Isis read capabilities around \hyperlink{classCinisis}{Cinisis}. \hypertarget{classIsisReader_a70d1444cf56269795b4947dd82b2a4ac}{ \index{IsisReader@{IsisReader}!\_\-\_\-construct@{\_\-\_\-construct}} \index{\_\-\_\-construct@{\_\-\_\-construct}!IsisReader@{IsisReader}} -\subsubsection[{\_\-\_\-construct}]{\setlength{\rightskip}{0pt plus 5cm}IsisReader::\_\-\_\-construct (\$ {\em config} = {\ttfamily null})}} +\subsubsection[{\_\-\_\-construct}]{\setlength{\rightskip}{0pt plus 5cm}IsisReader::\_\-\_\-construct ( +\begin{DoxyParamCaption} +\item[{\$}]{ config = {\ttfamily null}} +\end{DoxyParamCaption} +)}} \label{classIsisReader_a70d1444cf56269795b4947dd82b2a4ac} Constructor. @@ -50,7 +54,11 @@ Constructor. \hypertarget{classIsisReader_a4610ebcf69c197e2c596965e2dc0358e}{ \index{IsisReader@{IsisReader}!explodeBrackets@{explodeBrackets}} \index{explodeBrackets@{explodeBrackets}!IsisReader@{IsisReader}} -\subsubsection[{explodeBrackets}]{\setlength{\rightskip}{0pt plus 5cm}IsisReader::explodeBrackets (\$ {\em subject})}} +\subsubsection[{explodeBrackets}]{\setlength{\rightskip}{0pt plus 5cm}IsisReader::explodeBrackets ( +\begin{DoxyParamCaption} +\item[{\$}]{ subject} +\end{DoxyParamCaption} +)}} \label{classIsisReader_a4610ebcf69c197e2c596965e2dc0358e} Explode a bracketed string into values. Just strings inside brackets are returned. @@ -63,7 +71,11 @@ Array of matched strings. \hypertarget{classIsisReader_a3cc08df25da082046d496db93778709b}{ \index{IsisReader@{IsisReader}!explodeValue@{explodeValue}} \index{explodeValue@{explodeValue}!IsisReader@{IsisReader}} -\subsubsection[{explodeValue}]{\setlength{\rightskip}{0pt plus 5cm}IsisReader::explodeValue (\$ {\em value})}} +\subsubsection[{explodeValue}]{\setlength{\rightskip}{0pt plus 5cm}IsisReader::explodeValue ( +\begin{DoxyParamCaption} +\item[{\$}]{ value} +\end{DoxyParamCaption} +)}} \label{classIsisReader_a3cc08df25da082046d496db93778709b} Explode values from fields or subfields. Split values inside brackets if needed, but then doesn't return any value outside brackets. @@ -76,7 +88,11 @@ Array with values. \hypertarget{classIsisReader_aa6099ed6bd276b32bd7bba184f144529}{ \index{IsisReader@{IsisReader}!filterBrackets@{filterBrackets}} \index{filterBrackets@{filterBrackets}!IsisReader@{IsisReader}} -\subsubsection[{filterBrackets}]{\setlength{\rightskip}{0pt plus 5cm}IsisReader::filterBrackets (\$ {\em values})}} +\subsubsection[{filterBrackets}]{\setlength{\rightskip}{0pt plus 5cm}IsisReader::filterBrackets ( +\begin{DoxyParamCaption} +\item[{\$}]{ values} +\end{DoxyParamCaption} +)}} \label{classIsisReader_aa6099ed6bd276b32bd7bba184f144529} Filter out brackets from strings. @@ -89,7 +105,11 @@ Filtered string or array. \hypertarget{classIsisReader_a109a6ef49b2190bfbcee796dae954baf}{ \index{IsisReader@{IsisReader}!hasBrackets@{hasBrackets}} \index{hasBrackets@{hasBrackets}!IsisReader@{IsisReader}} -\subsubsection[{hasBrackets}]{\setlength{\rightskip}{0pt plus 5cm}IsisReader::hasBrackets (\$ {\em value})}} +\subsubsection[{hasBrackets}]{\setlength{\rightskip}{0pt plus 5cm}IsisReader::hasBrackets ( +\begin{DoxyParamCaption} +\item[{\$}]{ value} +\end{DoxyParamCaption} +)}} \label{classIsisReader_a109a6ef49b2190bfbcee796dae954baf} Check if a string has brackets. @@ -102,7 +122,11 @@ True if string has brackets, false otherwise. \hypertarget{classIsisReader_ae65e172e3b5c9ac3c8a5e1352ba80904}{ \index{IsisReader@{IsisReader}!joinSubfields@{joinSubfields}} \index{joinSubfields@{joinSubfields}!IsisReader@{IsisReader}} -\subsubsection[{joinSubfields}]{\setlength{\rightskip}{0pt plus 5cm}IsisReader::joinSubfields ()}} +\subsubsection[{joinSubfields}]{\setlength{\rightskip}{0pt plus 5cm}IsisReader::joinSubfields ( +\begin{DoxyParamCaption} +{} +\end{DoxyParamCaption} +)}} \label{classIsisReader_ae65e172e3b5c9ac3c8a5e1352ba80904} Whether to join field and subfields in a single array. @@ -112,7 +136,11 @@ Boolean. \hypertarget{classIsisReader_afa6e3d3d94854913e5ed2604919d2316}{ \index{IsisReader@{IsisReader}!open@{open}} \index{open@{open}!IsisReader@{IsisReader}} -\subsubsection[{open}]{\setlength{\rightskip}{0pt plus 5cm}IsisReader::open (\$ {\em config})}} +\subsubsection[{open}]{\setlength{\rightskip}{0pt plus 5cm}IsisReader::open ( +\begin{DoxyParamCaption} +\item[{\$}]{ config} +\end{DoxyParamCaption} +)}} \label{classIsisReader_afa6e3d3d94854913e5ed2604919d2316} Open a database. @@ -122,7 +150,11 @@ Open a database. \hypertarget{classIsisReader_a630791a319bec2bc55d0102cbb7f93df}{ \index{IsisReader@{IsisReader}!read@{read}} \index{read@{read}!IsisReader@{IsisReader}} -\subsubsection[{read}]{\setlength{\rightskip}{0pt plus 5cm}IsisReader::read (\$ {\em entry})}} +\subsubsection[{read}]{\setlength{\rightskip}{0pt plus 5cm}IsisReader::read ( +\begin{DoxyParamCaption} +\item[{\$}]{ entry} +\end{DoxyParamCaption} +)}} \label{classIsisReader_a630791a319bec2bc55d0102cbb7f93df} Alias to \$isis-\/$>$db-\/$>$\hyperlink{classIsisReader_a630791a319bec2bc55d0102cbb7f93df}{read()}. @@ -135,7 +167,11 @@ Resulting data. \hypertarget{classIsisReader_a99ce7b10b2997dad6a64558ac1f9f10e}{ \index{IsisReader@{IsisReader}!removeBrackets@{removeBrackets}} \index{removeBrackets@{removeBrackets}!IsisReader@{IsisReader}} -\subsubsection[{removeBrackets}]{\setlength{\rightskip}{0pt plus 5cm}IsisReader::removeBrackets (\$ {\em value})}} +\subsubsection[{removeBrackets}]{\setlength{\rightskip}{0pt plus 5cm}IsisReader::removeBrackets ( +\begin{DoxyParamCaption} +\item[{\$}]{ value} +\end{DoxyParamCaption} +)}} \label{classIsisReader_a99ce7b10b2997dad6a64558ac1f9f10e} Remove brackets from strings whithin an array. @@ -148,7 +184,11 @@ Array with strings without brackets. \hypertarget{classIsisReader_acba8842f0033356fff66c0f88391921e}{ \index{IsisReader@{IsisReader}!removeBracketsCallback@{removeBracketsCallback}} \index{removeBracketsCallback@{removeBracketsCallback}!IsisReader@{IsisReader}} -\subsubsection[{removeBracketsCallback}]{\setlength{\rightskip}{0pt plus 5cm}IsisReader::removeBracketsCallback (\&\$ {\em value} = {\ttfamily NULL})}} +\subsubsection[{removeBracketsCallback}]{\setlength{\rightskip}{0pt plus 5cm}IsisReader::removeBracketsCallback ( +\begin{DoxyParamCaption} +\item[{\&\$}]{ value = {\ttfamily NULL}} +\end{DoxyParamCaption} +)}} \label{classIsisReader_acba8842f0033356fff66c0f88391921e} Remove brackets from strings whithin an array. Callback version @@ -158,7 +198,11 @@ Remove brackets from strings whithin an array. Callback version \hypertarget{classIsisReader_a60ece3bbe11a2b4ac6afa6e65f282724}{ \index{IsisReader@{IsisReader}!removeBracketsFromArray@{removeBracketsFromArray}} \index{removeBracketsFromArray@{removeBracketsFromArray}!IsisReader@{IsisReader}} -\subsubsection[{removeBracketsFromArray}]{\setlength{\rightskip}{0pt plus 5cm}IsisReader::removeBracketsFromArray (\&\$ {\em values})}} +\subsubsection[{removeBracketsFromArray}]{\setlength{\rightskip}{0pt plus 5cm}IsisReader::removeBracketsFromArray ( +\begin{DoxyParamCaption} +\item[{\&\$}]{ values} +\end{DoxyParamCaption} +)}} \label{classIsisReader_a60ece3bbe11a2b4ac6afa6e65f282724} Remove brackets from strings whithin an array. -- cgit v1.2.3