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/classCinisis.tex | 63 ++++++++++++++++++++++++++++++++++++++-------- 1 file changed, 53 insertions(+), 10 deletions(-) (limited to 'doc/latex/classCinisis.tex') diff --git a/doc/latex/classCinisis.tex b/doc/latex/classCinisis.tex index 7f6193b..79999b6 100644 --- a/doc/latex/classCinisis.tex +++ b/doc/latex/classCinisis.tex @@ -44,7 +44,11 @@ static \hyperlink{classCinisis_ac470ab9dc1f8c02545708f1c7b820d9e}{main\_\-field\ \hypertarget{classCinisis_ab9cb7a94d6a5dfb13d50e83e58a4cc10}{ \index{Cinisis@{Cinisis}!\_\-\_\-construct@{\_\-\_\-construct}} \index{\_\-\_\-construct@{\_\-\_\-construct}!Cinisis@{Cinisis}} -\subsubsection[{\_\-\_\-construct}]{\setlength{\rightskip}{0pt plus 5cm}Cinisis::\_\-\_\-construct (\$ {\em config} = {\ttfamily NULL})}} +\subsubsection[{\_\-\_\-construct}]{\setlength{\rightskip}{0pt plus 5cm}Cinisis::\_\-\_\-construct ( +\begin{DoxyParamCaption} +\item[{\$}]{ config = {\ttfamily NULL}} +\end{DoxyParamCaption} +)}} \label{classCinisis_ab9cb7a94d6a5dfb13d50e83e58a4cc10} Constructor. @@ -57,7 +61,11 @@ Constructor. \hypertarget{classCinisis_a125ecd4426e15e2c27daa16d4aaac3f2}{ \index{Cinisis@{Cinisis}!base@{base}} \index{base@{base}!Cinisis@{Cinisis}} -\subsubsection[{base}]{\setlength{\rightskip}{0pt plus 5cm}static Cinisis::base ()\hspace{0.3cm}{\ttfamily \mbox{[}static\mbox{]}}}} +\subsubsection[{base}]{\setlength{\rightskip}{0pt plus 5cm}static Cinisis::base ( +\begin{DoxyParamCaption} +{} +\end{DoxyParamCaption} +)\hspace{0.3cm}{\ttfamily \mbox{[}static\mbox{]}}}} \label{classCinisis_a125ecd4426e15e2c27daa16d4aaac3f2} Get library base folder. @@ -67,7 +75,11 @@ Return base folder. \hypertarget{classCinisis_ae6f679192f136ba61e85130ccab8e7ef}{ \index{Cinisis@{Cinisis}!check@{check}} \index{check@{check}!Cinisis@{Cinisis}} -\subsubsection[{check}]{\setlength{\rightskip}{0pt plus 5cm}static Cinisis::check (\$ {\em config})\hspace{0.3cm}{\ttfamily \mbox{[}static\mbox{]}}}} +\subsubsection[{check}]{\setlength{\rightskip}{0pt plus 5cm}static Cinisis::check ( +\begin{DoxyParamCaption} +\item[{\$}]{ config} +\end{DoxyParamCaption} +)\hspace{0.3cm}{\ttfamily \mbox{[}static\mbox{]}}}} \label{classCinisis_ae6f679192f136ba61e85130ccab8e7ef} Check configuration. @@ -80,7 +92,12 @@ Array with configuration or FALSE on error. \hypertarget{classCinisis_aac686f5d4862085721eb0de1d6203a57}{ \index{Cinisis@{Cinisis}!file@{file}} \index{file@{file}!Cinisis@{Cinisis}} -\subsubsection[{file}]{\setlength{\rightskip}{0pt plus 5cm}static Cinisis::file (\$ {\em config} = {\ttfamily NULL}, \/ \$ {\em section} = {\ttfamily 'config'})\hspace{0.3cm}{\ttfamily \mbox{[}static\mbox{]}}}} +\subsubsection[{file}]{\setlength{\rightskip}{0pt plus 5cm}static Cinisis::file ( +\begin{DoxyParamCaption} +\item[{\$}]{ config = {\ttfamily NULL}, } +\item[{\$}]{ section = {\ttfamily 'config'}} +\end{DoxyParamCaption} +)\hspace{0.3cm}{\ttfamily \mbox{[}static\mbox{]}}}} \label{classCinisis_aac686f5d4862085721eb0de1d6203a57} Get a file path. @@ -93,7 +110,11 @@ Return the assembled file path. \hypertarget{classCinisis_a0163d3358b31657bd6e91f94aa618918}{ \index{Cinisis@{Cinisis}!join\_\-subfields@{join\_\-subfields}} \index{join\_\-subfields@{join\_\-subfields}!Cinisis@{Cinisis}} -\subsubsection[{join\_\-subfields}]{\setlength{\rightskip}{0pt plus 5cm}static Cinisis::join\_\-subfields (\$ {\em format})\hspace{0.3cm}{\ttfamily \mbox{[}static\mbox{]}}}} +\subsubsection[{join\_\-subfields}]{\setlength{\rightskip}{0pt plus 5cm}static Cinisis::join\_\-subfields ( +\begin{DoxyParamCaption} +\item[{\$}]{ format} +\end{DoxyParamCaption} +)\hspace{0.3cm}{\ttfamily \mbox{[}static\mbox{]}}}} \label{classCinisis_a0163d3358b31657bd6e91f94aa618918} Whether to join field and subfields in a single array. @@ -106,7 +127,11 @@ Boolean. \hypertarget{classCinisis_a0bd044303b01793f1a59c54040ff0242}{ \index{Cinisis@{Cinisis}!load@{load}} \index{load@{load}!Cinisis@{Cinisis}} -\subsubsection[{load}]{\setlength{\rightskip}{0pt plus 5cm}Cinisis::load (\$ {\em file})}} +\subsubsection[{load}]{\setlength{\rightskip}{0pt plus 5cm}Cinisis::load ( +\begin{DoxyParamCaption} +\item[{\$}]{ file} +\end{DoxyParamCaption} +)}} \label{classCinisis_a0bd044303b01793f1a59c54040ff0242} Config file load. @@ -119,7 +144,12 @@ Array with configuration or FALSE if error. \hypertarget{classCinisis_ac470ab9dc1f8c02545708f1c7b820d9e}{ \index{Cinisis@{Cinisis}!main\_\-field\_\-name@{main\_\-field\_\-name}} \index{main\_\-field\_\-name@{main\_\-field\_\-name}!Cinisis@{Cinisis}} -\subsubsection[{main\_\-field\_\-name}]{\setlength{\rightskip}{0pt plus 5cm}static Cinisis::main\_\-field\_\-name (\$ {\em format}, \/ \$ {\em key})\hspace{0.3cm}{\ttfamily \mbox{[}static\mbox{]}}}} +\subsubsection[{main\_\-field\_\-name}]{\setlength{\rightskip}{0pt plus 5cm}static Cinisis::main\_\-field\_\-name ( +\begin{DoxyParamCaption} +\item[{\$}]{ format, } +\item[{\$}]{ key} +\end{DoxyParamCaption} +)\hspace{0.3cm}{\ttfamily \mbox{[}static\mbox{]}}}} \label{classCinisis_ac470ab9dc1f8c02545708f1c7b820d9e} Determine the main field name depending on db configuration. @@ -132,7 +162,11 @@ Main field name, 'field' by default. \hypertarget{classCinisis_ad5ebe493037aad5a2d8a2f6c51fab09f}{ \index{Cinisis@{Cinisis}!open@{open}} \index{open@{open}!Cinisis@{Cinisis}} -\subsubsection[{open}]{\setlength{\rightskip}{0pt plus 5cm}Cinisis::open (\$ {\em config})}} +\subsubsection[{open}]{\setlength{\rightskip}{0pt plus 5cm}Cinisis::open ( +\begin{DoxyParamCaption} +\item[{\$}]{ config} +\end{DoxyParamCaption} +)}} \label{classCinisis_ad5ebe493037aad5a2d8a2f6c51fab09f} Open an ISIS database. @@ -142,7 +176,12 @@ Open an ISIS database. \hypertarget{classCinisis_ae8d2f767bfb149031b1ac7077c45c7d6}{ \index{Cinisis@{Cinisis}!parse@{parse}} \index{parse@{parse}!Cinisis@{Cinisis}} -\subsubsection[{parse}]{\setlength{\rightskip}{0pt plus 5cm}Cinisis::parse (\$ {\em config}, \/ \$ {\em class} = {\ttfamily \_\-\_\-CLASS\_\-\_\-})}} +\subsubsection[{parse}]{\setlength{\rightskip}{0pt plus 5cm}Cinisis::parse ( +\begin{DoxyParamCaption} +\item[{\$}]{ config, } +\item[{\$}]{ class = {\ttfamily \_\-\_\-CLASS\_\-\_\-}} +\end{DoxyParamCaption} +)}} \label{classCinisis_ae8d2f767bfb149031b1ac7077c45c7d6} Parse configuration. @@ -155,7 +194,11 @@ Array with configuration or FALSE on error. \hypertarget{classCinisis_add6ffac62cffb6ba5e5b0bec552b2cee}{ \index{Cinisis@{Cinisis}!yaml@{yaml}} \index{yaml@{yaml}!Cinisis@{Cinisis}} -\subsubsection[{yaml}]{\setlength{\rightskip}{0pt plus 5cm}static Cinisis::yaml (\$ {\em file})\hspace{0.3cm}{\ttfamily \mbox{[}static\mbox{]}}}} +\subsubsection[{yaml}]{\setlength{\rightskip}{0pt plus 5cm}static Cinisis::yaml ( +\begin{DoxyParamCaption} +\item[{\$}]{ file} +\end{DoxyParamCaption} +)\hspace{0.3cm}{\ttfamily \mbox{[}static\mbox{]}}}} \label{classCinisis_add6ffac62cffb6ba5e5b0bec552b2cee} Load YAML into array using backend libraries. -- cgit v1.2.3