svn commit - mysqldoc@docsrva: r5323 - branches/telcos/refman-5.1 trunk/ndbapi

[jon]

Author: jstephens
Date: 2007-03-13 11:01:07 +0100 (Tue, 13 Mar 2007)
New Revision: 5323

Log:

Reformat.



Modified:
   branches/telcos/refman-5.1/news-5.1.xml
   trunk/ndbapi/ndb-classes.xml


Modified: branches/telcos/refman-5.1/news-5.1.xml
===================================================================
--- branches/telcos/refman-5.1/news-5.1.xml	2007-03-13 09:59:03 UTC (rev 5322)
+++ branches/telcos/refman-5.1/news-5.1.xml	2007-03-13 10:01:07 UTC (rev 5323)
Changed blocks: 2, Lines Added: 4, Lines Deleted: 4; 1215 bytes

@@ -118,16 +118,16 @@
     </para>
 
     <itemizedlist>
-      
+
       <listitem>
         <para>
           <emphasis role="bold">NDB API</emphasis>: It is now possible
           to specify the transaction coordinator when starting a
           transaction. See <xref linkend="class-ndb-starttransaction"/>,
-          for more information. 
+          for more information.
         </para>
       </listitem>
-      
+
       <listitem>
         <para>
           <emphasis role="bold">NDB API</emphasis>: It is now possible

@@ -137,7 +137,7 @@
           <literal>lock_ndb_objects()</literal>,
           <literal>get_next_ndb_object()</literal>, and
           <literal>unlock_ndb_objects()</literal>. For more information
-          about these methods and their use, see 
+          about these methods and their use, see
           <xref linkend="class-ndb-cluster-connection-get-next-ndb-object"/>,
           in the MySQL Cluster API Guide.
         </para>


Modified: trunk/ndbapi/ndb-classes.xml
===================================================================
--- trunk/ndbapi/ndb-classes.xml	2007-03-13 09:59:03 UTC (rev 5322)
+++ trunk/ndbapi/ndb-classes.xml	2007-03-13 10:01:07 UTC (rev 5323)
Changed blocks: 17, Lines Added: 108, Lines Deleted: 59; 9980 bytes

@@ -991,11 +991,13 @@
         <para>
           Beginning with MySQL 5.1.16/NDB-6.2.0, it is possible to
           suggest which node node should be used to act as the
-          transaction coordinator. 
+          transaction coordinator.
         </para>
-        
+
         <formalpara>
+
           <title>Signature</title>
+
           <para>
 <programlisting>
 NdbTransaction* startTransaction

@@ -1007,15 +1009,19 @@
     )
 </programlisting>
           </para>
+
         </formalpara>
-        
+
         <formalpara>
+
           <title>Parameters</title>
+
           <para>
             When specifying the transactioncoordinator, this method
             takes four parameters:
-            
+
             <itemizedlist>
+
               <listitem>
                 <para>
                   A pointer to a <replaceable>table</replaceable>

@@ -1024,6 +1030,7 @@
                   coordinator.
                 </para>
               </listitem>
+
               <listitem>
                 <para>
                   A null-terminated array of pointers to a

@@ -1032,32 +1039,36 @@
                   read from metadata and checked against the passed
                   value.
                 </para>
-                
+
                 <para>
                   A <literal>Key_part_ptr</literal> is defined as shown
                   here:
-                  
+
 <programlisting>
 struct Key_part_ptr
     {
       const void * <replaceable>ptr</replaceable>;
       unsigned <replaceable>len</replaceable>;
     }
-</programlisting>                  
+</programlisting>
                 </para>
               </listitem>
+
               <listitem>
                 <para>
                   A pointer to a temporary buffer be used to calculate
                   the hash value.
                 </para>
               </listitem>
+
               <listitem>
                 <para>
                   The length of the buffer.
                 </para>
               </listitem>
+
             </itemizedlist>
+
             If <replaceable>xfrmbuf</replaceable> is
             <literal>NULL</literal> (the default), then a call to
             <literal>malloc()</literal> or
<literal>free()</literal> is

@@ -1066,8 +1077,9 @@
             <literal>xfrmbuf</literal> is not
<literal>NULL</literal>
             and <replaceable>xfrmbuflen</replaceable> is too small.
           </para>
+
         </formalpara>
-        
+
         <para>
           It is still possible to use this method as before, without
           specifying the transaction coordinator. In either case, you

@@ -2337,19 +2349,20 @@
 -->
 
       </section>
-      
+
       <section id="class-ndb-cluster-connection-get-next-ndb-object">
+
        
<title><literal>ndb_cluster_connection::get_next_ndb_object()</literal></title>
-        
+
         <indexterm>
           <primary>ndb_cluster_connection</primary>
           <secondary>get_next_ndb_object() method</secondary>
         </indexterm>
-        
+
         <indexterm>
           <primary>get_next_ndb_object() (method of
ndb_cluster_connection)</primary>
         </indexterm>
-        
+
         <indexterm>
           <primary>iteration</primary>
           <secondary>Ndb objects</secondary>

@@ -2358,17 +2371,20 @@
         &telco-warning-section;
         
         <formalpara>
+
           <title>Description</title>
-          
+
           <para>
             This method is used to iterate over a set of
             <literal>Ndb</literal> objects.
           </para>
+
         </formalpara>
-        
+
         <formalpara>
+
           <title>Signature</title>
-          
+
           <para>
 <programlisting>
 const Ndb* get_next_ndb_object

@@ -2377,42 +2393,52 @@
     )
 </programlisting>
           </para>
+
         </formalpara>
-        
+
         <formalpara>
+
           <title>Parameters</title>
-          
+
           <para>
             This method takes a single parameter, a pointer to the last
             <literal>Ndb</literal> object to have been retrieved or
-            <literal>NULL</literal>. 
+            <literal>NULL</literal>.
           </para>
+
         </formalpara>
-        
+
         <formalpara>
+
           <title>Return Value</title>
-          
+
           <para>
             Returns the next <literal>Ndb</literal> object, or
             <literal>NULL</literal> if no more
<literal>Ndb</literal>
             objects are available.
           </para>
+
         </formalpara>
-        
+
         <formalpara>
+
           <title>Iterating over <literal>Ndb</literal>
objects</title>
+
           <para>
-            To retrieve all existing <literal>Ndb</literal> objects: 
-            
+            To retrieve all existing <literal>Ndb</literal> objects:
+
             <orderedlist>
+
               <listitem>
-                <para>Invoke the <literal>lock_ndb_objects()</literal>
+                <para>
+                  Invoke the <literal>lock_ndb_objects()</literal>
                   method. This prevents the creation of any new
                   instances of <literal>Ndb</literal> until the
                   <literal>unlock_ndb_objects()</literal> method is
-                  called. 
+                  called.
                 </para>
               </listitem>
+
               <listitem>
                 <para>
                   Retrieve the first available <literal>Ndb</literal>

@@ -2423,9 +2449,10 @@
                   next <literal>get_next_ndb_object()</literal> call,
                   and so on. When a pointer to the last available
                   <literal>Ndb</literal> instance is used, the method
-                  returns <literal>NULL</literal>. 
+                  returns <literal>NULL</literal>.
                 </para>
               </listitem>
+
               <listitem>
                 <para>
                   After you have retrieved all desired

@@ -2434,16 +2461,20 @@
                   <literal>unlock_ndb_objects()</literal> method.
                 </para>
               </listitem>
+
             </orderedlist>
           </para>
+
         </formalpara>
-        
+
         <para>
-          See also <xref linkend="class-ndb-cluster-connection-lock-ndb-objects"/>,
-          and <xref linkend="class-ndb-cluster-connection-unlock-ndb-objects"/>.
+          See also
+          <xref linkend="class-ndb-cluster-connection-lock-ndb-objects"/>,
+          and
+          <xref linkend="class-ndb-cluster-connection-unlock-ndb-objects"/>.
         </para>
-        
-        <!--        
+
+<!--        
         <formalpara>
           <title>Example</title>
           

@@ -2454,18 +2485,20 @@
 </programlisting>
           </para>
         </formalpara>
- -->       
-        
+ -->
+
       </section>
-      
+
       <section id="class-ndb-cluster-connection-lock-ndb-objects">
+
        
<title><literal>ndb_cluster_connection::lock_ndb_objects()</literal></title>
         
         &telco-warning-section;
         
         <formalpara>
+
           <title>Description</title>
-          
+
           <para>
             Calling this method prevents the creation of new instances
             of the <literal>Ndb</literal> class. This method must be

@@ -2473,11 +2506,13 @@
             <literal>Ndb</literal> objects using
             <literal>get_next_ndb_object()</literal>.
           </para>
+
         </formalpara>
-        
+
         <formalpara>
+
           <title>Signature</title>
-          
+
           <para>
 <programlisting>
 void lock_ndb_objects

@@ -2486,30 +2521,35 @@
     )
 </programlisting>
           </para>
+
         </formalpara>
-        
+
         <formalpara>
+
           <title>Parameters</title>
-          
+
           <para>
             <emphasis>None</emphasis>.
           </para>
+
         </formalpara>
-        
+
         <formalpara>
+
           <title>Return Value</title>
-          
+
           <para>
             <emphasis>None</emphasis>.
           </para>
+
         </formalpara>
-        
+
         <para>
           This method was added in MySQL 5.1.16/NDB-6.2.0. For more
-          information, see 
+          information, see
           <xref linkend="class-ndb-cluster-connection-get-next-ndb-object"/>.
         </para>
-        
+
 <!--        
         <formalpara>
           <title>Example</title>

@@ -2521,18 +2561,20 @@
 </programlisting>
           </para>
         </formalpara>
--->        
-        
+-->
+
       </section>
-      
+
       <section id="class-ndb-cluster-connection-unlock-ndb-objects">
+
        
<title><literal>ndb_cluster_connection::unlock_ndb_objects()</literal></title>
         
         &telco-warning-section;
         
         <formalpara>
+
           <title>Description</title>
-          
+
           <para>
             This method undoes the effects of the
             <literal>lock_ndb_objects()</literal> method, making it

@@ -2542,11 +2584,13 @@
             objects using the <literal>get_next_ndb_object()</literal>
             method.
           </para>
+
         </formalpara>
-        
+
         <formalpara>
+
           <title>Signature</title>
-          
+
           <para>
 <programlisting>
 void unlock_ndb_objects

@@ -2555,29 +2599,34 @@
     )
 </programlisting>
           </para>
+
         </formalpara>
-        
+
         <formalpara>
+
           <title>Parameters</title>
-          
+
           <para>
             <emphasis>None</emphasis>.
           </para>
+
         </formalpara>
-        
+
         <formalpara>
+
           <title>Return Value</title>
-          
+
           <para>
             <emphasis>None</emphasis>.
           </para>
+
         </formalpara>
-        
+
         <para>
-          For more information, see 
+          For more information, see
           <xref linkend="class-ndb-cluster-connection-get-next-ndb-object"/>.
         </para>
-        
+
 <!--        
         <formalpara>
           <title>Example</title>

@@ -2589,8 +2638,8 @@
 </programlisting>
           </para>
         </formalpara>
--->        
-        
+-->
+
       </section>
 
     </section>