From: <mie...@us...> - 2012-06-13 00:30:59
|
Revision: 7888 http://oorexx.svn.sourceforge.net/oorexx/?rev=7888&view=rev Author: miesfeld Date: 2012-06-13 00:30:52 +0000 (Wed, 13 Jun 2012) Log Message: ----------- Work on ooSQLite docs, fix tags Modified Paths: -------------- docs/trunk/oosqlite/oosqliteBackup.xml docs/trunk/oosqlite/oosqliteStmt.xml Modified: docs/trunk/oosqlite/oosqliteBackup.xml =================================================================== --- docs/trunk/oosqlite/oosqliteBackup.xml 2012-06-13 00:21:05 UTC (rev 7887) +++ docs/trunk/oosqlite/oosqliteBackup.xml 2012-06-13 00:30:52 UTC (rev 7888) @@ -144,5 +144,575 @@ </variablelist> </section> <!-- End ooSQLiteMutex::new() --> +<section id="atrFinished"><title>finished (Attribute)</title> +<indexterm><primary>finished</primary></indexterm> +<indexterm><primary>ooSQLiteBackup class</primary><secondary>finished</secondary></indexterm> +<programlisting> +<![CDATA[ +>>--finished----------------------------------------------------->< +>>--finished-=-varName------------------------------------------->< + +]]> +</programlisting> + +<para> + xx +</para> +<variablelist> + <varlistentry><term><emphasis role="bold">finished get:</emphasis></term> + <listitem> + <para> + details about get + </para> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">finished set:</emphasis></term> + <listitem> + <para> + details about set + </para> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Remarks:</emphasis></term> + <listitem> + <para> + Additional comments. + </para> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Details</emphasis></term> + <listitem> + <para> + Anything? + </para> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Example:</emphasis></term> + <listitem> + <para> + This example ... +<programlisting> +<![CDATA[ + + +]]> +</programlisting> + </para> + </listitem></varlistentry> +</variablelist> +</section> <!-- End ooSQLiteBackup::finished() [attribute] --> + +<section id="atrInitCodeClsBackup"><title>initCode (Attribute)</title> +<indexterm><primary>initCode</primary></indexterm> +<indexterm><primary>ooSQLiteBackup class</primary><secondary>initCode</secondary></indexterm> +<programlisting> +<![CDATA[ +>>--initCode----------------------------------------------------->< + +>>--initCode-=-varName------------------------------------------->< + +]]> +</programlisting> + +<para> + xx +</para> +<variablelist> + <varlistentry><term><emphasis role="bold">initCode get:</emphasis></term> + <listitem> + <para> + details about get + </para> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">initCode set:</emphasis></term> + <listitem> + <para> + details about set + </para> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Remarks:</emphasis></term> + <listitem> + <para> + Additional comments. + </para> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Details</emphasis></term> + <listitem> + <para> + Anything? + </para> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Example:</emphasis></term> + <listitem> + <para> + This example ... +<programlisting> +<![CDATA[ + + +]]> +</programlisting> + </para> + </listitem></varlistentry> +</variablelist> +</section> <!-- End ooSQLiteBackup::initCode() [attribute] --> + +<section id="atrLastErrCodeClsBackup"><title>lastErrCode (Attribute)</title> +<indexterm><primary>lastErrCode</primary></indexterm> +<indexterm><primary>ooSQLiteBackup class</primary><secondary>lastErrCode</secondary></indexterm> +<programlisting> +<![CDATA[ +>>--lastErrCode----------------------------------------------------->< + +>>--lastErrCode-=-varName------------------------------------------->< + +]]> +</programlisting> + +<para> + xx +</para> +<variablelist> + <varlistentry><term><emphasis role="bold">lastErrCode get:</emphasis></term> + <listitem> + <para> + details about get + </para> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">lastErrCode set:</emphasis></term> + <listitem> + <para> + details about set + </para> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Remarks:</emphasis></term> + <listitem> + <para> + Additional comments. + </para> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Details</emphasis></term> + <listitem> + <para> + Anything? + </para> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Example:</emphasis></term> + <listitem> + <para> + This example ... +<programlisting> +<![CDATA[ + + +]]> +</programlisting> + </para> + </listitem></varlistentry> +</variablelist> +</section> <!-- End ooSQLiteBackup::lastErrCode() [attribute] --> + +<section id="atrLastErrMsgClsBackup"><title>lastErrMsg (Attribute)</title> +<indexterm><primary>lastErrMsg</primary></indexterm> +<indexterm><primary>ooSQLiteBackup class</primary><secondary>lastErrMsg</secondary></indexterm> +<programlisting> +<![CDATA[ +>>--lastErrMsg----------------------------------------------------->< + +>>--lastErrMsg-=-varName------------------------------------------->< + +]]> +</programlisting> + +<para> + xx +</para> +<variablelist> + <varlistentry><term><emphasis role="bold">lastErrMsg get:</emphasis></term> + <listitem> + <para> + details about get + </para> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">lastErrMsg set:</emphasis></term> + <listitem> + <para> + details about set + </para> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Remarks:</emphasis></term> + <listitem> + <para> + Additional comments. + </para> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Details</emphasis></term> + <listitem> + <para> + Anything? + </para> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Example:</emphasis></term> + <listitem> + <para> + This example ... +<programlisting> +<![CDATA[ + + +]]> +</programlisting> + </para> + </listitem></varlistentry> +</variablelist> +</section> <!-- End ooSQLiteBackup::lastErrMsg() [attribute] --> + +<section id="atrPageCount"><title>pageCount (Attribute)</title> +<indexterm><primary>pageCount</primary></indexterm> +<indexterm><primary>ooSQLiteBackup class</primary><secondary>pageCount</secondary></indexterm> +<programlisting> +<![CDATA[ +>>--pageCount----------------------------------------------------->< + +>>--pageCount-=-varName------------------------------------------->< + +]]> +</programlisting> + +<para> + xx +</para> +<variablelist> + <varlistentry><term><emphasis role="bold">pageCount get:</emphasis></term> + <listitem> + <para> + details about get + </para> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">pageCount set:</emphasis></term> + <listitem> + <para> + details about set + </para> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Remarks:</emphasis></term> + <listitem> + <para> + Additional comments. + </para> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Details</emphasis></term> + <listitem> + <para> + Anything? + </para> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Example:</emphasis></term> + <listitem> + <para> + This example ... +<programlisting> +<![CDATA[ + + +]]> +</programlisting> + </para> + </listitem></varlistentry> +</variablelist> +</section> <!-- End ooSQLiteBackup::pageCount() [attribute] --> + + +<section id="atrRemaining"><title>remaining (Attribute)</title> +<indexterm><primary>remaining</primary></indexterm> +<indexterm><primary>ooSQLiteBackup class</primary><secondary>remaining</secondary></indexterm> +<programlisting> +<![CDATA[ +>>--remaining----------------------------------------------------->< + +>>--remaining-=-varName------------------------------------------->< + +]]> +</programlisting> + +<para> + xx +</para> +<variablelist> + <varlistentry><term><emphasis role="bold">remaining get:</emphasis></term> + <listitem> + <para> + details about get + </para> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">remaining set:</emphasis></term> + <listitem> + <para> + details about set + </para> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Remarks:</emphasis></term> + <listitem> + <para> + Additional comments. + </para> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Details</emphasis></term> + <listitem> + <para> + Anything? + </para> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Example:</emphasis></term> + <listitem> + <para> + This example ... +<programlisting> +<![CDATA[ + + +]]> +</programlisting> + </para> + </listitem></varlistentry> +</variablelist> +</section> <!-- End ooSQLiteBackup::remaining() [attribute] --> + + +<section id="atrSaveDestConn"><title>saveDestConn (Attribute)</title> +<indexterm><primary>saveDestConn</primary></indexterm> +<indexterm><primary>ooSQLiteBackup class</primary><secondary>saveDestConn</secondary></indexterm> +<programlisting> +<![CDATA[ +>>--saveDestConn----------------------------------------------------->< + +>>--saveDestConn-=-varName------------------------------------------->< + +]]> +</programlisting> + +<para> + xx +</para> +<variablelist> + <varlistentry><term><emphasis role="bold">saveDestConn get:</emphasis></term> + <listitem> + <para> + details about get + </para> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">saveDestConn set:</emphasis></term> + <listitem> + <para> + details about set + </para> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Remarks:</emphasis></term> + <listitem> + <para> + Additional comments. + </para> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Details</emphasis></term> + <listitem> + <para> + Anything? + </para> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Example:</emphasis></term> + <listitem> + <para> + This example ... +<programlisting> +<![CDATA[ + + +]]> +</programlisting> + </para> + </listitem></varlistentry> +</variablelist> +</section> <!-- End ooSQLiteBackup::saveDestConn() [attribute] --> + + +<section id="mthFinish"><title>finish</title> +<indexterm><primary>finish</primary></indexterm> +<indexterm><primary>ooSQLiteBackup class</primary><secondary>finish</secondary></indexterm> +<programlisting> +<![CDATA[ +>>--finish(--+--------+--)--------------------------------------------->< + +--type--+ +]]> +</programlisting> + +<para> + xx +</para> +<variablelist> + <varlistentry><term><emphasis role="bold">Arguments:</emphasis></term> + <listitem> + <para> + The arguments are: + <variablelist> + <varlistentry><term>TERM</term> + <listitem> + <para> + xx + </para> + </listitem></varlistentry> + </variablelist> + </para> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Return value:</emphasis></term> + <listitem> + <para> + xx + </para> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Remarks:</emphasis></term> + <listitem> + <para> + Additional comments. + </para> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Details</emphasis></term> + <listitem> + <para> + Anything? + </para> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Example:</emphasis></term> + <listitem> + <para> + This example ... +<programlisting> +<![CDATA[ + +]]> +</programlisting> + </para> + </listitem></varlistentry> +</variablelist> +</section> <!-- End ooSQLiteBackup::finish() --> + + +<section id="mthGetDestConn"><title>getDestConn</title> +<indexterm><primary>getDestConn</primary></indexterm> +<indexterm><primary>ooSQLiteBackup class</primary><secondary>getDestConn</secondary></indexterm> +<programlisting> +<![CDATA[ +>>--getDestConn(--+--------+--)--------------------------------------------->< + +--type--+ +]]> +</programlisting> + +<para> + xx +</para> +<variablelist> + <varlistentry><term><emphasis role="bold">Arguments:</emphasis></term> + <listitem> + <para> + The arguments are: + <variablelist> + <varlistentry><term>TERM</term> + <listitem> + <para> + xx + </para> + </listitem></varlistentry> + </variablelist> + </para> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Return value:</emphasis></term> + <listitem> + <para> + xx + </para> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Remarks:</emphasis></term> + <listitem> + <para> + Additional comments. + </para> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Details</emphasis></term> + <listitem> + <para> + Anything? + </para> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Example:</emphasis></term> + <listitem> + <para> + This example ... +<programlisting> +<![CDATA[ + +]]> +</programlisting> + </para> + </listitem></varlistentry> +</variablelist> +</section> <!-- End ooSQLiteBackup::getDestConn() --> + + +<section id="mthStep"><title>step</title> +<indexterm><primary>step</primary></indexterm> +<indexterm><primary>ooSQLiteBackup class</primary><secondary>step</secondary></indexterm> +<programlisting> +<![CDATA[ +>>--step(--+--------+--)--------------------------------------------->< + +--type--+ +]]> +</programlisting> + +<para> + xx +</para> +<variablelist> + <varlistentry><term><emphasis role="bold">Arguments:</emphasis></term> + <listitem> + <para> + The arguments are: + <variablelist> + <varlistentry><term>TERM</term> + <listitem> + <para> + xx + </para> + </listitem></varlistentry> + </variablelist> + </para> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Return value:</emphasis></term> + <listitem> + <para> + xx + </para> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Remarks:</emphasis></term> + <listitem> + <para> + Additional comments. + </para> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Details</emphasis></term> + <listitem> + <para> + Anything? + </para> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Example:</emphasis></term> + <listitem> + <para> + This example ... +<programlisting> +<![CDATA[ + +]]> +</programlisting> + </para> + </listitem></varlistentry> +</variablelist> +</section> <!-- End ooSQLiteBackup::step() --> + + </section> Modified: docs/trunk/oosqlite/oosqliteStmt.xml =================================================================== --- docs/trunk/oosqlite/oosqliteStmt.xml 2012-06-13 00:21:05 UTC (rev 7887) +++ docs/trunk/oosqlite/oosqliteStmt.xml 2012-06-13 00:30:52 UTC (rev 7888) @@ -257,7 +257,7 @@ </section> <!-- End ooSQLiteStmt::finalized() [attribute] --> -<section id="atrLastErrCode"><title>lastErrCode (Attribute)</title> +<section id="atrLastErrCodeClsStmt"><title>lastErrCode (Attribute)</title> <indexterm><primary>lastErrCode</primary></indexterm> <indexterm><primary>ooSQLiteStmt class</primary><secondary>lastErrCode</secondary></indexterm> <programlisting> This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |