Author: jstephens
Date: 2008-08-15 15:55:53 +0200 (Fri, 15 Aug 2008)
New Revision: 11567
Log:
Documented some methods
Modified:
trunk/ndbapi/class-ndbinterpretedcode.xml
Modified: trunk/ndbapi/class-ndbinterpretedcode.xml
===================================================================
--- trunk/ndbapi/class-ndbinterpretedcode.xml 2008-08-15 12:35:04 UTC (rev 11566)
+++ trunk/ndbapi/class-ndbinterpretedcode.xml 2008-08-15 13:55:53 UTC (rev 11567)
Changed blocks: 78, Lines Added: 347, Lines Deleted: 120; 19239 bytes
@@ -443,11 +443,12 @@
<title>Return Value</title>
<para>
- <emphasis>None</emphasis>.
+ An instance of <literal>NdbInterpretedCode</literal>.
</para>
</formalpara>
+<!--
<formalpara>
<title>Example</title>
@@ -459,61 +460,128 @@
</para>
</formalpara>
+-->
</section>
- <section id="class-ndbinterpretedcode-load-const-null">
+ <section id="class-ndbinterpretedcode-load-methods">
- <title><literal>NdbInterpretedCode::load_const_null()</literal></title>
+ <title><literal>NdbInterpretedCode</literal> Methods for Loading Values into
+ Registers</title>
<indexterm>
- <primary>NdbInterpretedCode::load_const_null()</primary>
+ <primary>NdbInterpretedCode register-loading methods</primary>
</indexterm>
<indexterm>
- <primary>load_const_null() (method of NdbInterepretedCode)</primary>
+ <primary>Register-loading methods (NdbInterepretedCode)</primary>
</indexterm>
- <formalpara>
+ <para>
+ The methods described in this section are used to load constant
+ values into <literal>NdbInterpretedCode</literal> program
+ registers. The space required by each of these methods is shown
+ in the following table:
- <title>Description</title>
+ <informaltable>
+ <tgroup cols="3">
+ <colspec colwidth="50*"/>
+ <colspec colwidth="25*"/>
+ <colspec colwidth="25*"/>
+ <thead>
+ <row>
+ <entry>Method</entry>
+ <entry>Buffer (words)</entry>
+ <entry>Request message (words)</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry><literal>load_const_null()</literal></entry>
+ <entry>1</entry>
+ <entry>1</entry>
+ </row>
+ <row>
+ <entry><literal>load_const_u16()</literal></entry>
+ <entry>1</entry>
+ <entry>1</entry>
+ </row>
+ <row>
+ <entry><literal>load_const_u32()</literal></entry>
+ <entry>2</entry>
+ <entry>2</entry>
+ </row>
+ <row>
+ <entry><literal>load_const_u64()</literal></entry>
+ <entry>3</entry>
+ <entry>3</entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+ </para>
- <para></para>
+ <section id="class-ndbinterpretedcode-load-const-null">
- </formalpara>
+ <title><literal>NdbInterpretedCode::load_const_null()</literal></title>
- <formalpara>
+ <indexterm>
+ <primary>NdbInterpretedCode::load_const_null()</primary>
+ </indexterm>
- <title>Signature</title>
+ <indexterm>
+ <primary>load_const_null() (method of NdbInterepretedCode)</primary>
+ </indexterm>
- <para>
+ <formalpara>
+
+ <title>Description</title>
+
+ <para>
+ This method is used to load a <literal>NULL</literal> value
+ into a register.
+ </para>
+
+ </formalpara>
+
+ <formalpara>
+
+ <title>Signature</title>
+
+ <para>
<programlisting>
-
+int load_const_null
+ (
+ Uint32 <replaceable>RegDest</replaceable>
+ )
</programlisting>
- </para>
+ </para>
- </formalpara>
+ </formalpara>
- <formalpara>
+ <formalpara>
- <title>Parameters</title>
+ <title>Parameters</title>
- <para>
- <emphasis>None</emphasis>.
- </para>
+ <para>
+ This method takes a single parameter, the register into
+ which to place the <literal>NULL</literal>.
+ </para>
- </formalpara>
+ </formalpara>
- <formalpara>
+ <formalpara>
- <title>Return Value</title>
+ <title>Return Value</title>
- <para>
- <emphasis>None</emphasis>.
- </para>
+ <para>
+ Returns <literal>0</literal> on success,
+ <literal>-1</literal> otherwise.
+ </para>
- </formalpara>
+ </formalpara>
+<!--
<formalpara>
<title>Example</title>
@@ -525,61 +593,89 @@
</para>
</formalpara>
+-->
- </section>
+ </section>
- <section id="class-ndbinterpretedcode-load-const-u16">
+ <section id="class-ndbinterpretedcode-load-const-u16">
- <title><literal>NdbInterpretedCode::load_const_u16()</literal></title>
+ <title><literal>NdbInterpretedCode::load_const_u16()</literal></title>
- <indexterm>
- <primary>NdbInterpretedCode::load_const_u16()</primary>
- </indexterm>
+ <indexterm>
+ <primary>NdbInterpretedCode::load_const_u16()</primary>
+ </indexterm>
- <indexterm>
- <primary>load_const_u16() (method of NdbInterepretedCode)</primary>
- </indexterm>
+ <indexterm>
+ <primary>load_const_u16() (method of NdbInterepretedCode)</primary>
+ </indexterm>
- <formalpara>
+ <formalpara>
- <title>Description</title>
+ <title>Description</title>
- <para></para>
+ <para>
+ This method loads a 16-bit value into the specified
+ interpreter register.
+ </para>
- </formalpara>
+ </formalpara>
- <formalpara>
+ <formalpara>
- <title>Signature</title>
+ <title>Signature</title>
- <para>
+ <para>
<programlisting>
-
+int load_const_u16
+ (
+ Uint32 <replaceable>RegDest</replaceable>,
+ Uint32 <replaceable>Constant</replaceable>
+ )
</programlisting>
- </para>
+ </para>
- </formalpara>
+ </formalpara>
- <formalpara>
+ <formalpara>
- <title>Parameters</title>
+ <title>Parameters</title>
- <para>
- <emphasis>None</emphasis>.
- </para>
+ <para>
+ This method takes two parameters:
- </formalpara>
+ <itemizedlist>
- <formalpara>
+ <listitem>
+ <para>
+ <replaceable>RegDest</replaceable>: The register into
+ which the value should be loaded.
+ </para>
+ </listitem>
- <title>Return Value</title>
+ <listitem>
+ <para>
+ A <replaceable>Constant</replaceable> value to be
+ loaded
+ </para>
+ </listitem>
- <para>
- <emphasis>None</emphasis>.
- </para>
+ </itemizedlist>
+ </para>
- </formalpara>
+ </formalpara>
+ <formalpara>
+
+ <title>Return Value</title>
+
+ <para>
+ Returns <literal>0</literal> on success,
+ <literal>-1</literal> otherwise.
+ </para>
+
+ </formalpara>
+
+<!--
<formalpara>
<title>Example</title>
@@ -591,61 +687,89 @@
</para>
</formalpara>
+-->
- </section>
+ </section>
- <section id="class-ndbinterpretedcode-load-const-u32">
+ <section id="class-ndbinterpretedcode-load-const-u32">
- <title><literal>NdbInterpretedCode::load_const_u32()</literal></title>
+ <title><literal>NdbInterpretedCode::load_const_u32()</literal></title>
- <indexterm>
- <primary>NdbInterpretedCode::load_const_u32()</primary>
- </indexterm>
+ <indexterm>
+ <primary>NdbInterpretedCode::load_const_u32()</primary>
+ </indexterm>
- <indexterm>
- <primary>load_const_u32() (method of NdbInterepretedCode)</primary>
- </indexterm>
+ <indexterm>
+ <primary>load_const_u32() (method of NdbInterepretedCode)</primary>
+ </indexterm>
- <formalpara>
+ <formalpara>
- <title>Description</title>
+ <title>Description</title>
- <para></para>
+ <para>
+ This method loads a 32-bit value into the specified
+ interpreter register.
+ </para>
- </formalpara>
+ </formalpara>
- <formalpara>
+ <formalpara>
- <title>Signature</title>
+ <title>Signature</title>
- <para>
+ <para>
<programlisting>
-
+int load_const_u32
+ (
+ Uint32 <replaceable>RegDest</replaceable>,
+ Uint32 <replaceable>Constant</replaceable>
+ )
</programlisting>
- </para>
+ </para>
- </formalpara>
+ </formalpara>
- <formalpara>
+ <formalpara>
- <title>Parameters</title>
+ <title>Parameters</title>
- <para>
- <emphasis>None</emphasis>.
- </para>
+ <para>
+ This method takes two parameters:
- </formalpara>
+ <itemizedlist>
- <formalpara>
+ <listitem>
+ <para>
+ <replaceable>RegDest</replaceable>: The register into
+ which the value should be loaded.
+ </para>
+ </listitem>
- <title>Return Value</title>
+ <listitem>
+ <para>
+ A <replaceable>Constant</replaceable> value to be
+ loaded
+ </para>
+ </listitem>
- <para>
- <emphasis>None</emphasis>.
- </para>
+ </itemizedlist>
+ </para>
- </formalpara>
+ </formalpara>
+ <formalpara>
+
+ <title>Return Value</title>
+
+ <para>
+ Returns <literal>0</literal> on success,
+ <literal>-1</literal> otherwise.
+ </para>
+
+ </formalpara>
+
+<!--
<formalpara>
<title>Example</title>
@@ -657,61 +781,89 @@
</para>
</formalpara>
+-->
- </section>
+ </section>
- <section id="class-ndbinterpretedcode-load-const-u64">
+ <section id="class-ndbinterpretedcode-load-const-u64">
- <title><literal>NdbInterpretedCode::load_const_u64()</literal></title>
+ <title><literal>NdbInterpretedCode::load_const_u64()</literal></title>
- <indexterm>
- <primary>NdbInterpretedCode::load_const_u64()</primary>
- </indexterm>
+ <indexterm>
+ <primary>NdbInterpretedCode::load_const_u64()</primary>
+ </indexterm>
- <indexterm>
- <primary>load_const_u64() (method of NdbInterepretedCode)</primary>
- </indexterm>
+ <indexterm>
+ <primary>load_const_u64() (method of NdbInterepretedCode)</primary>
+ </indexterm>
- <formalpara>
+ <formalpara>
- <title>Description</title>
+ <title>Description</title>
- <para></para>
+ <para>
+ This method loads a 64-bit value into the specified
+ interpreter register.
+ </para>
- </formalpara>
+ </formalpara>
- <formalpara>
+ <formalpara>
- <title>Signature</title>
+ <title>Signature</title>
- <para>
+ <para>
<programlisting>
-
+int load_const_u64
+ (
+ Uint32 <replaceable>RegDest</replaceable>,
+ Uint64 <replaceable>Constant</replaceable>
+ )
</programlisting>
- </para>
+ </para>
- </formalpara>
+ </formalpara>
- <formalpara>
+ <formalpara>
- <title>Parameters</title>
+ <title>Parameters</title>
- <para>
- <emphasis>None</emphasis>.
- </para>
+ <para>
+ This method takes two parameters:
- </formalpara>
+ <itemizedlist>
- <formalpara>
+ <listitem>
+ <para>
+ <replaceable>RegDest</replaceable>: The register into
+ which the value should be loaded.
+ </para>
+ </listitem>
- <title>Return Value</title>
+ <listitem>
+ <para>
+ A <replaceable>Constant</replaceable> value to be
+ loaded
+ </para>
+ </listitem>
- <para>
- <emphasis>None</emphasis>.
- </para>
+ </itemizedlist>
+ </para>
- </formalpara>
+ </formalpara>
+ <formalpara>
+
+ <title>Return Value</title>
+
+ <para>
+ Returns <literal>0</literal> on success,
+ <literal>-1</literal> otherwise.
+ </para>
+
+ </formalpara>
+
+<!--
<formalpara>
<title>Example</title>
@@ -723,7 +875,10 @@
</para>
</formalpara>
+-->
+ </section>
+
</section>
<section id="class-ndbinterpretedcode-read-attr">
@@ -778,6 +933,7 @@
</formalpara>
+<!--
<formalpara>
<title>Example</title>
@@ -789,6 +945,7 @@
</para>
</formalpara>
+-->
</section>
@@ -844,6 +1001,7 @@
</formalpara>
+<!--
<formalpara>
<title>Example</title>
@@ -855,6 +1013,7 @@
</para>
</formalpara>
+-->
</section>
@@ -910,6 +1069,7 @@
</formalpara>
+<!--
<formalpara>
<title>Example</title>
@@ -921,6 +1081,7 @@
</para>
</formalpara>
+-->
</section>
@@ -976,6 +1137,7 @@
</formalpara>
+<!--
<formalpara>
<title>Example</title>
@@ -987,6 +1149,7 @@
</para>
</formalpara>
+-->
</section>
@@ -1042,6 +1205,7 @@
</formalpara>
+<!--
<formalpara>
<title>Example</title>
@@ -1053,6 +1217,7 @@
</para>
</formalpara>
+-->
</section>
@@ -1108,6 +1273,7 @@
</formalpara>
+<!--
<formalpara>
<title>Example</title>
@@ -1119,6 +1285,7 @@
</para>
</formalpara>
+-->
</section>
@@ -1174,6 +1341,7 @@
</formalpara>
+<!--
<formalpara>
<title>Example</title>
@@ -1185,6 +1353,7 @@
</para>
</formalpara>
+-->
</section>
@@ -1240,6 +1409,7 @@
</formalpara>
+<!--
<formalpara>
<title>Example</title>
@@ -1251,6 +1421,7 @@
</para>
</formalpara>
+-->
</section>
@@ -1306,6 +1477,7 @@
</formalpara>
+<!--
<formalpara>
<title>Example</title>
@@ -1317,6 +1489,7 @@
</para>
</formalpara>
+-->
</section>
@@ -1372,6 +1545,7 @@
</formalpara>
+<!--
<formalpara>
<title>Example</title>
@@ -1383,6 +1557,7 @@
</para>
</formalpara>
+-->
</section>
@@ -1438,6 +1613,7 @@
</formalpara>
+<!--
<formalpara>
<title>Example</title>
@@ -1449,6 +1625,7 @@
</para>
</formalpara>
+-->
</section>
@@ -1504,6 +1681,7 @@
</formalpara>
+<!--
<formalpara>
<title>Example</title>
@@ -1515,6 +1693,7 @@
</para>
</formalpara>
+-->
</section>
@@ -1570,6 +1749,7 @@
</formalpara>
+<!--
<formalpara>
<title>Example</title>
@@ -1581,6 +1761,7 @@
</para>
</formalpara>
+-->
</section>
@@ -1636,6 +1817,7 @@
</formalpara>
+<!--
<formalpara>
<title>Example</title>
@@ -1647,6 +1829,7 @@
</para>
</formalpara>
+-->
</section>
@@ -1702,6 +1885,7 @@
</formalpara>
+<!--
<formalpara>
<title>Example</title>
@@ -1713,6 +1897,7 @@
</para>
</formalpara>
+-->
</section>
@@ -1768,6 +1953,7 @@
</formalpara>
+<!--
<formalpara>
<title>Example</title>
@@ -1779,6 +1965,7 @@
</para>
</formalpara>
+-->
</section>
@@ -1834,6 +2021,7 @@
</formalpara>
+<!--
<formalpara>
<title>Example</title>
@@ -1845,6 +2033,7 @@
</para>
</formalpara>
+-->
</section>
@@ -1900,6 +2089,7 @@
</formalpara>
+<!--
<formalpara>
<title>Example</title>
@@ -1911,6 +2101,7 @@
</para>
</formalpara>
+-->
</section>
@@ -1966,6 +2157,7 @@
</formalpara>
+<!--
<formalpara>
<title>Example</title>
@@ -1977,6 +2169,7 @@
</para>
</formalpara>
+-->
</section>
@@ -2032,6 +2225,7 @@
</formalpara>
+<!--
<formalpara>
<title>Example</title>
@@ -2043,6 +2237,7 @@
</para>
</formalpara>
+-->
</section>
@@ -2098,6 +2293,7 @@
</formalpara>
+<!--
<formalpara>
<title>Example</title>
@@ -2109,6 +2305,7 @@
</para>
</formalpara>
+-->
</section>
@@ -2164,6 +2361,7 @@
</formalpara>
+<!--
<formalpara>
<title>Example</title>
@@ -2175,6 +2373,7 @@
</para>
</formalpara>
+-->
</section>
@@ -2230,6 +2429,7 @@
</formalpara>
+<!--
<formalpara>
<title>Example</title>
@@ -2241,6 +2441,7 @@
</para>
</formalpara>
+-->
</section>
@@ -2296,6 +2497,7 @@
</formalpara>
+<!--
<formalpara>
<title>Example</title>
@@ -2307,6 +2509,7 @@
</para>
</formalpara>
+-->
</section>
@@ -2362,6 +2565,7 @@
</formalpara>
+<!--
<formalpara>
<title>Example</title>
@@ -2373,6 +2577,7 @@
</para>
</formalpara>
+-->
</section>
@@ -2428,6 +2633,7 @@
</formalpara>
+<!--
<formalpara>
<title>Example</title>
@@ -2439,6 +2645,7 @@
</para>
</formalpara>
+-->
</section>
@@ -2494,6 +2701,7 @@
</formalpara>
+<!--
<formalpara>
<title>Example</title>
@@ -2505,6 +2713,7 @@
</para>
</formalpara>
+-->
</section>
@@ -2560,6 +2769,7 @@
</formalpara>
+<!--
<formalpara>
<title>Example</title>
@@ -2571,6 +2781,7 @@
</para>
</formalpara>
+-->
</section>
@@ -2626,6 +2837,7 @@
</formalpara>
+<!--
<formalpara>
<title>Example</title>
@@ -2637,6 +2849,7 @@
</para>
</formalpara>
+-->
</section>
@@ -2692,6 +2905,7 @@
</formalpara>
+<!--
<formalpara>
<title>Example</title>
@@ -2703,6 +2917,7 @@
</para>
</formalpara>
+-->
</section>
@@ -2758,6 +2973,7 @@
</formalpara>
+<!--
<formalpara>
<title>Example</title>
@@ -2769,6 +2985,7 @@
</para>
</formalpara>
+-->
</section>
@@ -2824,6 +3041,7 @@
</formalpara>
+<!--
<formalpara>
<title>Example</title>
@@ -2835,6 +3053,7 @@
</para>
</formalpara>
+-->
</section>
@@ -2890,6 +3109,7 @@
</formalpara>
+<!--
<formalpara>
<title>Example</title>
@@ -2901,6 +3121,7 @@
</para>
</formalpara>
+-->
</section>
@@ -2956,6 +3177,7 @@
</formalpara>
+<!--
<formalpara>
<title>Example</title>
@@ -2967,6 +3189,7 @@
</para>
</formalpara>
+-->
</section>
@@ -3022,6 +3245,7 @@
</formalpara>
+<!--
<formalpara>
<title>Example</title>
@@ -3033,6 +3257,7 @@
</para>
</formalpara>
+-->
</section>
@@ -3088,6 +3313,7 @@
</formalpara>
+<!--
<formalpara>
<title>Example</title>
@@ -3099,6 +3325,7 @@
</para>
</formalpara>
+-->
</section>
| Thread |
|---|
| • svn commit - mysqldoc@docsrva: r11567 - trunk/ndbapi | jon | 15 Aug |
