List:Commits« Previous MessageNext Message »
From:jon.stephens Date:November 25 2010 12:49pm
Subject:svn commit - mysqldoc@docsrva: r24018 - trunk/ndbapi
View as plain text  
Author: jstephens
Date: 2010-11-25 13:49:27 +0100 (Thu, 25 Nov 2010)
New Revision: 24018

Log:

Add NDB API auto-link markup



Modified:
   trunk/ndbapi/ndb-ndbscanoperation.xml
   trunk/ndbapi/ndb-ndbtransaction.xml
   trunk/ndbapi/ndb-object.xml
   trunk/ndbapi/ndb-operationoptions.xml
   trunk/ndbapi/ndb-partitionspec.xml
   trunk/ndbapi/ndb-recordspecification.xml
   trunk/ndbapi/ndb-scanoptions.xml
   trunk/ndbapi/ndb-setvaluespec.xml
   trunk/ndbapi/ndb-table.xml
   trunk/ndbapi/ndb-tablespace.xml
   trunk/ndbapi/ndb-undofile.xml
   trunk/ndbapi/overview.xml


Modified: trunk/ndbapi/ndb-ndbscanoperation.xml
===================================================================
--- trunk/ndbapi/ndb-ndbscanoperation.xml	2010-11-25 11:57:00 UTC (rev 24017)
+++ trunk/ndbapi/ndb-ndbscanoperation.xml	2010-11-25 12:49:27 UTC (rev 24018)
Changed blocks: 32, Lines Added: 102, Lines Deleted: 109; 19268 bytes

@@ -25,7 +25,7 @@
     <title>Parent class</title>
 
     <para>
-      <link linkend="ndb-ndboperation">NdbOperation</link>
+      <literal role="ndbapi">NdbOperation</literal>
     </para>
 
   </formalpara>

@@ -35,7 +35,7 @@
     <title>Child classes</title>
 
     <para>
-      <link linkend="ndb-ndbindexscanoperation">NdbIndexScanOperation</link>
+      <literal role="ndbapi">NdbIndexScanOperation</literal>
     </para>
 
   </formalpara>

@@ -47,9 +47,7 @@
     <para>
       The <literal>NdbScanOperation</literal> class represents a
       scanning operation used in a transaction. This class inherits from
-      <literal>NdbOperation</literal>. For more information, see
-      <xref
-        linkend="ndb-ndboperation"/>.
+      <literal role="ndbapi">NdbOperation</literal>.
     </para>
 
   </formalpara>

@@ -57,10 +55,10 @@
   <note>
     <para>
       Beginning with MySQL Cluster NDB 6.2.14 and MySQL Cluster 6.3.12,
-      you must use the <literal>NdbInterpretedCode</literal> class
-      instead of <literal>NdbScanOperation</literal> when writing
-      interpreted programs used for scans. See
-      <xref linkend="ndb-ndbinterpretedcode"/>, for more information.
+      you must use the
+      <literal role="ndbapi">NdbInterpretedCode</literal> class instead
+      of <literal>NdbScanOperation</literal> when writing interpreted
+      programs used for scans.
     </para>
   </note>
 

@@ -87,50 +85,40 @@
       </thead>
       <tbody>
         <row>
-          <entry><literal><link linkend="ndb-ndbscanoperation-readtuples"
-                >readTuples()</link></literal></entry>
+          <entry><literal><link linkend="ndb-ndbscanoperation-readtuples">readTuples()</link></literal></entry>
           <entry>Reads tuples</entry>
         </row>
         <row>
-          <entry><literal><link linkend="ndb-ndbscanoperation-nextresult"
-                >nextResult()</link></literal></entry>
+          <entry><literal><link linkend="ndb-ndbscanoperation-nextresult">nextResult()</link></literal></entry>
           <entry>Gets the next tuple</entry>
         </row>
         <row>
-          <entry><literal><link linkend="ndb-ndbscanoperation-close"
-                >close()</link></literal></entry>
+          <entry><literal><link linkend="ndb-ndbscanoperation-close">close()</link></literal></entry>
           <entry>Closes the scan</entry>
         </row>
         <row>
-          <entry><literal><link linkend="ndb-ndbscanoperation-lockcurrenttuple"
-                >lockCurrentTuple()</link></literal></entry>
+          <entry><literal><link linkend="ndb-ndbscanoperation-lockcurrenttuple">lockCurrentTuple()</link></literal></entry>
           <entry>Locks the current tuple</entry>
         </row>
         <row>
-          <entry><literal><link
-                linkend="ndb-ndbscanoperation-updatecurrenttuple"
-                >updateCurrentTuple()</link></literal></entry>
+          <entry><literal><link linkend="ndb-ndbscanoperation-updatecurrenttuple">updateCurrentTuple()</link></literal></entry>
           <entry>Updates the current tuple</entry>
         </row>
         <row>
-          <entry><literal><link
-                linkend="ndb-ndbscanoperation-deletecurrenttuple"
-                >deleteCurrentTuple()</link></literal></entry>
+          <entry><literal><link linkend="ndb-ndbscanoperation-deletecurrenttuple">deleteCurrentTuple()</link></literal></entry>
           <entry>Deletes the current tuple</entry>
         </row>
         <row>
-          <entry><literal><link linkend="ndb-ndbscanoperation-restart"
-                >restart()</link></literal></entry>
+          <entry><literal><link linkend="ndb-ndbscanoperation-restart">restart()</link></literal></entry>
           <entry>Restarts the scan</entry>
         </row>
         <row>
-          <entry><literal><link linkend="ndb-ndbscanoperation-getndbtransaction"
-                >getNdbTransaction()</link></literal></entry>
-          <entry>Gets the <literal>NdbTransaction</literal> object for this scan</entry>
+          <entry><literal><link linkend="ndb-ndbscanoperation-getndbtransaction">getNdbTransaction()</link></literal></entry>
+          <entry>Gets the <literal role="ndbapi">NdbTransaction</literal> object for this
+            scan</entry>
         </row>
         <row>
-          <entry><literal><link linkend="ndb-ndbscanoperation-getpruned"
-                >getPruned()</link></literal></entry>
+          <entry><literal><link linkend="ndb-ndbscanoperation-getpruned">getPruned()</link></literal></entry>
           <entry>Used to find out whether this scan is pruned to a single partition</entry>
         </row>
       </tbody>

@@ -191,9 +179,7 @@
       Cluster NDB 6.2. They are supported for MySQL Cluster NDB 6.3 (and
       later) beginning with 6.3.17 (see Bug#38791). Both NDB 6.2 and NDB
       6.3 (as well as later MySQL Cluster releases) support MRR scans
-      using the
-      <literal><link linkend="ndb-ndbrecord">NdbRecord</link></literal>
-      interface.
+      using the <literal role="ndbapi">NdbRecord</literal> interface.
     </para>
   </note>
 

@@ -261,7 +247,8 @@
           </row>
           <row>
             <entry><literal>SF_ReadRangeNo</literal></entry>
-            <entry>Enables <literal>NdbIndexScanOperation::get_range_no()</literal></entry>
+            <entry>Enables
+              <literal role="ndbapi">NdbIndexScanOperation::get_range_no()</literal></entry>
           </row>
           <row>
             <entry><literal>SF_KeyInfo</literal></entry>

@@ -281,7 +268,7 @@
 
       <para>
         This section lists and describes the public methods of the
-        <literal>NdbScanOperation</literal> class.
+        <literal role="ndbapi">NdbScanOperation</literal> class.
       </para>
 
     </abstract>

@@ -289,9 +276,10 @@
     <note>
       <para>
         This class has no public constructor. To create an instance of
-        <literal>NdbScanOperation</literal>, it is necessary to use the
-        <literal>NdbTransaction::getNdbScanOperation()</literal> method.
-        See <xref linkend="ndb-ndbtransaction-getndbscanoperation"/>.
+        <literal role="ndbapi">NdbScanOperation</literal>, it is
+        necessary to use the
+        <literal role="ndbapi">NdbTransaction::getNdbScanOperation()</literal>
+        method.
       </para>
     </note>
 

@@ -350,9 +338,8 @@
         <listitem>
           <para>
             The lock <replaceable>mode</replaceable>; this is a
-            <literal>LockMode</literal> value as described in
-            <xref
-              linkend="ndb-ndboperation-lockmode"/>.
+            <literal role="ndbapi:NdbOperation">LockMode</literal>
+            value.
           </para>
 
           <caution>

@@ -368,8 +355,7 @@
 
             <para>
               The
-              <link linkend="ndb-ndbscanoperation-close"
-                  ><literal>NdbIndexScanOperation::close()</literal></link>
+              <literal role="ndbapi">NdbScanOperation::close()</literal>
               method is also affected by this deadlock, since all
               outstanding requests are serviced before the scan is
               actually closed.

@@ -398,8 +384,8 @@
             The <replaceable>batch</replaceable> parameter specifies how
             many records will be returned to the client from the server
             by the next
-            <literal>NdbScanOperation::nextResult(true)</literal> method
-            call. Use <literal>0</literal> to specify the maximum
+            <literal role="ndbapi">NdbScanOperation::nextResult(true)</literal>
+            method call. Use <literal>0</literal> to specify the maximum
             automatically.
           </para>
 

@@ -460,9 +446,9 @@
           This method is used to fetch the next tuple in a scan
           transaction. Following each call to
           <literal>nextResult()</literal>, the buffers and
-          <literal>NdbRecAttr</literal> objects defined in
-          <literal>NdbOperation::getValue()</literal> are updated with
-          values from the scanned tuple.
+          <literal role="ndbapi">NdbRecAttr</literal> objects defined in
+          <literal role="ndbapi">NdbOperation::getValue()</literal> are
+          updated with values from the scanned tuple.
         </para>
 
       </formalpara>

@@ -596,10 +582,11 @@
             returning 0). This pointer is valid (only) until the next
             call to <literal>nextResult()</literal> when
             <replaceable>fetchAllowed</replaceable> is true. The
-            <literal>NdbRecord</literal> object defining the row format
-            must be specified beforehand using
-            <literal>NdbTransaction::scanTable()</literal> (or
-            <literal>NdbTransaction::scanIndex()</literal>.
+            <literal role="ndbapi">NdbRecord</literal> object defining
+            the row format must be specified beforehand using
+            <literal role="ndbapi">NdbTransaction::scanTable()</literal>
+            (or
+            <literal role="ndbapi">NdbTransaction::scanIndex()</literal>.
           </para>
         </listitem>
 

@@ -835,7 +822,7 @@
       <para>
         Beginning with MySQL Cluster NDB 6.2.3, the following signature
         is also supported for this method, when using
-        <literal>NdbRecord</literal>:
+        <literal role="ndbapi">NdbRecord</literal>:
       </para>
 
 <programlisting>

@@ -865,10 +852,9 @@
         <title>Parameters (when using <literal>NdbRecord</literal>)</title>
 
         <para>
-          When using the <literal>NdbRecord</literal> interface (see
-          <xref
-            linkend="ndb-ndbrecord"/>), this method
-          takes these parameters, as described in the following list:
+          When using the <literal role="ndbapi">NdbRecord</literal>
+          interface, this method takes these parameters, as described in
+          the following list:
         </para>
 
       </formalpara>

@@ -879,15 +865,16 @@
           <para>
             The transaction (<replaceable>takeOverTrans</replaceable>)
             that should perform the lock; when using
-            <literal>NdbRecord</literal> with scans, this parameter is
-            not optional.
+            <literal role="ndbapi">NdbRecord</literal> with scans, this
+            parameter is not optional.
           </para>
         </listitem>
 
         <listitem>
           <para>
-            The <literal>NdbRecord</literal> referenced by the scan.
-            This is required, even if no records are being read.
+            The <literal role="ndbapi">NdbRecord</literal> referenced by
+            the scan. This is required, even if no records are being
+            read.
           </para>
         </listitem>
 

@@ -910,10 +897,13 @@
 
       <important>
         <para>
-          Calling an <literal>NdbRecord</literal> scan lock takeover on
-          an <literal>NdbRecAttr</literal>-style scan is not valid, nor
-          is calling an <literal>NdbRecAttr</literal>-style scan lock
-          takeover on an <literal>NdbRecord</literal>-style scan.
+          Calling an <literal role="ndbapi">NdbRecord</literal> scan
+          lock takeover on an
+          <literal role="ndbapi">NdbRecAttr</literal>-style scan is not
+          valid, nor is calling an
+          <literal role="ndbapi">NdbRecAttr</literal>-style scan lock
+          takeover on an
+          <literal role="ndbapi">NdbRecord</literal>-style scan.
         </para>
       </important>
 

@@ -923,9 +913,8 @@
 
         <para>
           This method returns a pointer to an
-          <literal>NdbOperation</literal> object, or
-          <literal>NULL</literal>. (See
-          <xref linkend="ndb-ndboperation"/>.)
+          <literal role="ndbapi">NdbOperation</literal> object, or
+          <literal>NULL</literal>.
         </para>
 
       </formalpara>

@@ -994,8 +983,9 @@
 
       <para>
         Beginning with MySQL Cluster NDB 6.2.3, it is also possible to
-        employ this method, when using <literal>NdbRecord</literal> with
-        scans, as shown here:
+        employ this method, when using
+        <literal role="ndbapi">NdbRecord</literal> with scans, as shown
+        here:
       </para>
 
 <programlisting>

@@ -1029,9 +1019,10 @@
         <title>Parameters (when using <literal>NdbRecord</literal>)</title>
 
         <para>
-          When using the <literal>NdbRecord</literal> interface
-          (beginning with MySQL Cluster NDB 6.2.3), this method takes
-          the following parameters, as described in the following list:
+          When using the <literal role="ndbapi">NdbRecord</literal>
+          interface (beginning with MySQL Cluster NDB 6.2.3), this
+          method takes the following parameters, as described in the
+          following list:
         </para>
 
       </formalpara>

@@ -1048,8 +1039,8 @@
         <listitem>
           <para>
             The <replaceable>record</replaceable>
-            (<literal>NdbRecord</literal> object) referencing the column
-            used for the scan.
+            (<literal role="ndbapi">NdbRecord</literal> object)
+            referencing the column used for the scan.
           </para>
         </listitem>
 

@@ -1076,9 +1067,9 @@
         <title>Return value</title>
 
         <para>
-          This method returns an <literal>NdbOperation</literal> object
-          or <literal>NULL</literal>. (See
-          <xref linkend="ndb-ndboperation"/>.)
+          This method returns an
+          <literal role="ndbapi">NdbOperation</literal> object or
+          <literal>NULL</literal>.
         </para>
 
       </formalpara>

@@ -1127,9 +1118,9 @@
 
         <para>
           Originally (prior to the introduction of
-          <literal>NdbRecord</literal>), this method could be invoked
-          with a single optional parameter, in either of the ways shown
-          here:
+          <literal role="ndbapi">NdbRecord</literal>), this method could
+          be invoked with a single optional parameter, in either of the
+          ways shown here:
         </para>
 
       </formalpara>

@@ -1149,8 +1140,8 @@
 
       <para>
         Beginning with MySQL Cluster NDB 6.2.3, this method's signature
-        when performing <literal>NdbRecord</literal>-style scans is
-        shown here:
+        when performing <literal role="ndbapi">NdbRecord</literal>-style
+        scans is shown here:
       </para>
 
 <programlisting>

@@ -1186,9 +1177,9 @@
         <title>Parameters when using <literal>NdbRecord</literal></title>
 
         <para>
-          When used with the <literal>NdbRecord</literal> interface
-          (beginning with MySQL Cluster NDB 6.2.3), this method takes
-          the parameters listed here:
+          When used with the <literal role="ndbapi">NdbRecord</literal>
+          interface (beginning with MySQL Cluster NDB 6.2.3), this
+          method takes the parameters listed here:
         </para>
 
       </formalpara>

@@ -1199,16 +1190,16 @@
           <para>
             The transaction (<replaceable>takeOverTrans</replaceable>)
             that should perform the lock; when using
-            <literal>NdbRecord</literal> with scans, this parameter is
-            not optional.
+            <literal role="ndbapi">NdbRecord</literal> with scans, this
+            parameter is not optional.
           </para>
         </listitem>
 
         <listitem>
           <para>
-            The <literal>NdbRecord</literal> referenced by the scan.
-            This <replaceable>record</replaceable> value is required,
-            even if no records are being read.
+            The <literal role="ndbapi">NdbRecord</literal> referenced by
+            the scan. This <replaceable>record</replaceable> value is
+            required, even if no records are being read.
           </para>
         </listitem>
 

@@ -1229,14 +1220,14 @@
 
         <listitem>
           <para>
-            <literal><link linkend="ndb-operationoptions">OperationOptions</link></literal>
+            <literal role="ndbapi">OperationOptions</literal>
             (<replaceable>opts</replaceable>) can be used to provide
             more finely-grained control of operation definitions. An
-            <literal>OperationOptions</literal> structure is passed with
-            flags indicating which operation definition options are
-            present. Not all operation types support all operation
-            options; the options supported for each type of operation
-            are shown in the following table:
+            <literal role="ndbapi">OperationOptions</literal> structure
+            is passed with flags indicating which operation definition
+            options are present. Not all operation types support all
+            operation options; the options supported for each type of
+            operation are shown in the following table:
           </para>
 
           <informaltable>

@@ -1293,11 +1284,12 @@
             The optional <replaceable>sizeOfOptions</replaceable>
             parameter is used to preserve backward compatibility of this
             interface with previous definitions of the
-            <literal>OperationOptions</literal> structure. If an unusual
-            size is detected by the interface implementation, it can use
-            this to determine how to interpret the passed
-            <literal>OperationOptions</literal> structure. To enable
-            this functionality, the caller should pass
+            <literal role="ndbapi">OperationOptions</literal> structure.
+            If an unusual size is detected by the interface
+            implementation, it can use this to determine how to
+            interpret the passed
+            <literal role="ndbapi">OperationOptions</literal> structure.
+            To enable this functionality, the caller should pass
             <literal>sizeof(NdbOperation::OperationOptions)</literal>
             for the value of this argument.
           </para>

@@ -1434,9 +1426,9 @@
         <title>Description</title>
 
         <para>
-          Gets the <literal>NdbTransaction</literal> object for this
-          scan. This method is available beginning with MySQL Cluster
-          NDB 6.2.17 and MySQL Cluster NDB 6.3.19.
+          Gets the <literal role="ndbapi">NdbTransaction</literal>
+          object for this scan. This method is available beginning with
+          MySQL Cluster NDB 6.2.17 and MySQL Cluster NDB 6.3.19.
         </para>
 
       </formalpara>

@@ -1471,8 +1463,8 @@
         <title>Return value</title>
 
         <para>
-          A pointer to an <literal>NdbTransaction</literal> object. See
-          <xref linkend="ndb-ndbtransaction"/>.
+          A pointer to an
+          <literal role="ndbapi">NdbTransaction</literal> object.
         </para>
 
       </formalpara>

@@ -1514,8 +1506,9 @@
           operation has been pruned to a single partition. For scans
           defined using NdbRecord, this method can be called before or
           after the scan is executed. For scans not defined using
-          <literal>NdbRecord</literal>, <literal>getPruned()</literal>
-          is valid only after the scan has been executed.
+          <literal role="ndbapi">NdbRecord</literal>,
+          <literal>getPruned()</literal> is valid only after the scan
+          has been executed.
         </para>
 
       </formalpara>


Modified: trunk/ndbapi/ndb-ndbtransaction.xml
===================================================================
--- trunk/ndbapi/ndb-ndbtransaction.xml	2010-11-25 11:57:00 UTC (rev 24017)
+++ trunk/ndbapi/ndb-ndbtransaction.xml	2010-11-25 12:49:27 UTC (rev 24018)
Changed blocks: 79, Lines Added: 283, Lines Deleted: 251; 47763 bytes

@@ -47,15 +47,15 @@
     <para>
       A transaction is represented in the NDB API by an
       <literal>NdbTransaction</literal> object, which belongs to an
-      <literal>Ndb</literal> object and is created using
-      <literal>Ndb::startTransaction()</literal>. A transaction consists
-      of a list of operations represented by the
-      <literal>NdbOperation</literal> class, or by one of its
-      subclasses&mdash;<literal>NdbScanOperation</literal>,
-      <literal>NdbIndexOperation</literal>, or
-      <literal>NdbIndexScanOperation</literal> (see
-      <xref linkend="ndb-ndboperation"/>). Each operation access exactly
-      one table.
+      <literal role="ndbapi">Ndb</literal> object and is created using
+      <literal role="ndbapi">Ndb::startTransaction()</literal>. A
+      transaction consists of a list of operations represented by the
+      <literal role="ndbapi">NdbOperation</literal> class, or by one of
+      its
+      subclasses&mdash;<literal role="ndbapi">NdbScanOperation</literal>,
+      <literal role="ndbapi">NdbIndexOperation</literal>, or
+      <literal role="ndbapi">NdbIndexScanOperation</literal>. Each
+      operation access exactly one table.
     </para>
 
   </formalpara>

@@ -112,31 +112,32 @@
         operations can be defined on the same
         <literal>NdbTransaction</literal> object, in which case they are
         executed in parallel. When all operations are defined, the
-        <literal>execute()</literal> method sends them to the
-        <literal>NDB</literal> kernel for execution.
+        <literal role="ndbapi:NdbTransaction">execute()</literal> method
+        sends them to the <literal>NDB</literal> kernel for execution.
       </para>
     </listitem>
 
     <listitem>
       <para>
-        The <literal>execute()</literal> method returns when the
-        <literal>NDB</literal> kernel has completed execution of all
-        operations previously defined.
+        The <literal role="ndbapi:NdbTransaction">execute()</literal>
+        method returns when the <literal>NDB</literal> kernel has
+        completed execution of all operations previously defined.
       </para>
 
       <important>
         <para>
           All allocated operations should be properly defined
           <emphasis>before</emphasis> calling the
-          <literal>execute()</literal> method.
+          <literal role="ndbapi:NdbTransaction">execute()</literal>
+          method.
         </para>
       </important>
     </listitem>
 
     <listitem>
       <para>
-        <literal>execute()</literal> operates in one of the three modes
-        listed here:
+        <literal role="ndbapi:NdbTransaction">execute()</literal>
+        operates in one of the three modes listed here:
       </para>
 
       <itemizedlist>

@@ -166,9 +167,9 @@
       </itemizedlist>
 
       <para>
-        <literal>execute()</literal> is also equipped with an extra
-        error handling parameter, which provides the two alternatives
-        listed here:
+        <literal role="ndbapi:NdbTransaction">execute()</literal> is
+        also equipped with an extra error handling parameter, which
+        provides the two alternatives listed here:
       </para>
 
       <itemizedlist>

@@ -226,19 +227,19 @@
       <tbody>
         <row>
           <entry><literal><link linkend="ndb-ndbtransaction-getndboperation">getNdbOperation()</link></literal></entry>
-          <entry>Gets an <literal>NdbOperation</literal></entry>
+          <entry>Gets an <literal role="ndbapi">NdbOperation</literal></entry>
         </row>
         <row>
           <entry><literal><link linkend="ndb-ndbtransaction-getndbscanoperation">getNdbScanOperation()</link></literal></entry>
-          <entry>Gets an <literal>NdbScanOperation</literal></entry>
+          <entry>Gets an <literal role="ndbapi">NdbScanOperation</literal></entry>
         </row>
         <row>
           <entry><literal><link linkend="ndb-ndbtransaction-getndbindexscanoperation">getNdbIndexScanOperation()</link></literal></entry>
-          <entry>Gets an <literal>NdbIndexScanOperation</literal></entry>
+          <entry>Gets an <literal role="ndbapi">NdbIndexScanOperation</literal></entry>
         </row>
         <row>
           <entry><literal><link linkend="ndb-ndbtransaction-getndbindexoperation">getNdbIndexOperation()</link></literal></entry>
-          <entry>Gets an <literal>NdbIndexOperation</literal></entry>
+          <entry>Gets an <literal role="ndbapi">NdbIndexOperation</literal></entry>
         </row>
         <row>
           <entry><literal><link linkend="ndb-ndbtransaction-execute">execute</link></literal></entry>

@@ -282,31 +283,31 @@
         </row>
         <row>
           <entry><literal><link linkend="ndb-ndbtransaction-readtuple">readTuple()</link></literal></entry>
-          <entry>Read a tuple using <literal>NdbRecord</literal></entry>
+          <entry>Read a tuple using <literal role="ndbapi">NdbRecord</literal></entry>
         </row>
         <row>
           <entry><literal><link linkend="ndb-ndbtransaction-inserttuple">insertTuple()</link></literal></entry>
-          <entry>Insert a tuple using <literal>NdbRecord</literal></entry>
+          <entry>Insert a tuple using <literal role="ndbapi">NdbRecord</literal></entry>
         </row>
         <row>
           <entry><literal><link linkend="ndb-ndbtransaction-updatetuple">updateTuple()</link></literal></entry>
-          <entry>Update a tuple using <literal>NdbRecord</literal></entry>
+          <entry>Update a tuple using <literal role="ndbapi">NdbRecord</literal></entry>
         </row>
         <row>
           <entry><literal><link linkend="ndb-ndbtransaction-writetuple">writeTuple()</link></literal></entry>
-          <entry>Write a tuple using <literal>NdbRecord</literal></entry>
+          <entry>Write a tuple using <literal role="ndbapi">NdbRecord</literal></entry>
         </row>
         <row>
           <entry><literal><link linkend="ndb-ndbtransaction-deletetuple">deleteTuple()</link></literal></entry>
-          <entry>Delete a tuple using <literal>NdbRecord</literal></entry>
+          <entry>Delete a tuple using <literal role="ndbapi">NdbRecord</literal></entry>
         </row>
         <row>
           <entry><literal><link linkend="ndb-ndbtransaction-scantable">scanTable()</link></literal></entry>
-          <entry>Perform a table scan using <literal>NdbRecord</literal></entry>
+          <entry>Perform a table scan using <literal role="ndbapi">NdbRecord</literal></entry>
         </row>
         <row>
           <entry><literal><link linkend="ndb-ndbtransaction-scanindex">scanIndex()</link></literal></entry>
-          <entry>Perform an index scan using <literal>NdbRecord</literal></entry>
+          <entry>Perform an index scan using <literal role="ndbapi">NdbRecord</literal></entry>
         </row>
       </tbody>
     </tgroup>

@@ -314,13 +315,16 @@
 
   <note>
     <para>
-      The methods <literal>readTuple()</literal>,
-      <literal>insertTuple()</literal>,
-      <literal>updateTuple()</literal>, <literal>writeTuple()</literal>,
-      <literal>deleteTuple()</literal>, <literal>scanTable()</literal>,
-      and <literal>scanIndex()</literal> require the use of
-      <literal>NdbRecord</literal>, which is available beginning with
-      MySQL Cluster NDB 6.2.3.
+      The methods
+      <literal role="ndbapi:NdbTransaction">readTuple()</literal>,
+      <literal role="ndbapi:NdbTransaction">insertTuple()</literal>,
+      <literal role="ndbapi:NdbTransaction">updateTuple()</literal>,
+      <literal role="ndbapi:NdbTransaction">writeTuple()</literal>,
+      <literal role="ndbapi:NdbTransaction">deleteTuple()</literal>,
+      <literal role="ndbapi:NdbTransaction">scanTable()</literal>, and
+      <literal role="ndbapi:NdbTransaction">scanIndex()</literal>
+      require the use of <literal role="ndbapi">NdbRecord</literal>,
+      which is available beginning with MySQL Cluster NDB 6.2.3.
     </para>
 
     <para>

@@ -406,7 +410,7 @@
 
       <para>
         This section details the public types belonging to the
-        <literal>NdbTransaction</literal> class.
+        <literal role="ndbapi">NdbTransaction</literal> class.
       </para>
 
     </abstract>

@@ -474,18 +478,18 @@
       <important>
         <para>
           Beginning with MySQL Cluster NDB 6.2.0, this type belongs to
-          the <literal>NdbOperation</literal> class and its possible
-          values and default behavior have changed. NDB API application
-          code written against previous versions of MySQL Cluster that
-          refers explicitly to
+          the <literal role="ndbapi">NdbOperation</literal> class and
+          its possible values and default behavior have changed. NDB API
+          application code written against previous versions of MySQL
+          Cluster that refers explicitly to
           <literal>NdbTransaction::AbortOption</literal> values must be
           modified to work with MySQL Cluster NDB 6.2.0 or later.
         </para>
 
         <para>
           In particular, this effects the use of
-          <literal>NdbTransaction::execute()</literal> in MySQL Cluster
-          NDB 6.2.0 and later. See
+          <literal role="ndbapi">NdbTransaction::execute()</literal> in
+          MySQL Cluster NDB 6.2.0 and later. See
           <xref linkend="ndb-ndboperation-abortoption"/>, and
           <xref linkend="ndb-ndbtransaction-execute"/>, for more
           information.

@@ -645,7 +649,7 @@
 
       <para>
         This section lists and describes the public methods of the
-        <literal>NdbTransaction</literal> class.
+        <literal role="ndbapi">NdbTransaction</literal> class.
       </para>
 
     </abstract>

@@ -668,7 +672,8 @@
 
         <para>
           This method is used to create an
-          <literal>NdbOperation</literal> associated with a given table.
+          <literal role="ndbapi">NdbOperation</literal> associated with
+          a given table.
         </para>
 
       </formalpara>

@@ -701,8 +706,8 @@
         <title>Parameters</title>
 
         <para>
-          The <literal>Table</literal> object on which the operation is
-          to be performed. See <xref linkend="ndb-table"/>.
+          The <literal role="ndbapi">Table</literal> object on which the
+          operation is to be performed.
         </para>
 
       </formalpara>

@@ -712,8 +717,8 @@
         <title>Return value</title>
 
         <para>
-          A pointer to the new <literal>NdbOperation</literal>. See
-          <xref linkend="ndb-ndboperation"/>.
+          A pointer to the new
+          <literal role="ndbapi">NdbOperation</literal>.
         </para>
 
       </formalpara>

@@ -752,8 +757,8 @@
 
         <para>
           This method is used to create an
-          <literal>NdbScanOperation</literal> associated with a given
-          table.
+          <literal role="ndbapi">NdbScanOperation</literal> associated
+          with a given table.
         </para>
 
       </formalpara>

@@ -786,8 +791,8 @@
         <title>Parameters</title>
 
         <para>
-          The <literal>Table</literal> object on which the operation is
-          to be performed. See <xref linkend="ndb-table"/>.
+          The <literal role="ndbapi">Table</literal> object on which the
+          operation is to be performed.
         </para>
 
       </formalpara>

@@ -797,8 +802,8 @@
         <title>Return value</title>
 
         <para>
-          A pointer to the new <literal>NdbScanOperation</literal>. See
-          <xref linkend="ndb-ndbscanoperation"/>.
+          A pointer to the new
+          <literal role="ndbapi">NdbScanOperation</literal>.
         </para>
 
       </formalpara>

@@ -837,8 +842,8 @@
 
         <para>
           This method is used to create an
-          <literal>NdbIndexScanOperation</literal> associated with a
-          given table.
+          <literal role="ndbapi">NdbIndexScanOperation</literal>
+          associated with a given table.
         </para>
 
       </formalpara>

@@ -871,8 +876,8 @@
         <title>Parameters</title>
 
         <para>
-          The <literal>Index</literal> object on which the operation is
-          to be performed. See <xref linkend="ndb-index"/>.
+          The <literal role="ndbapi">Index</literal> object on which the
+          operation is to be performed.
         </para>
 
       </formalpara>

@@ -882,8 +887,8 @@
         <title>Return value</title>
 
         <para>
-          A pointer to the new <literal>NdbIndexScanOperation</literal>.
-          See <xref linkend="ndb-ndbindexscanoperation"/>.
+          A pointer to the new
+          <literal role="ndbapi">NdbIndexScanOperation</literal>.
         </para>
 
       </formalpara>

@@ -922,8 +927,8 @@
 
         <para>
           This method is used to create an
-          <literal>NdbIndexOperation</literal> associated with a given
-          table.
+          <literal role="ndbapi">NdbIndexOperation</literal> associated
+          with a given table.
         </para>
 
       </formalpara>

@@ -956,8 +961,8 @@
         <title>Parameters</title>
 
         <para>
-          The <literal>Index</literal> object on which the operation is
-          to be performed. See <xref linkend="ndb-index"/>.
+          The <literal role="ndbapi">Index</literal> object on which the
+          operation is to be performed.
         </para>
 
       </formalpara>

@@ -967,8 +972,8 @@
         <title>Return value</title>
 
         <para>
-          A pointer to the new <literal>NdbIndexOperation</literal>. See
-          <xref linkend="ndb-ndbindexoperation"/>.
+          A pointer to the new
+          <literal role="ndbapi">NdbIndexOperation</literal>.
         </para>
 
       </formalpara>

@@ -1051,7 +1056,8 @@
         <listitem>
           <para>
             An abort option
-            (<literal>NdbOperation::AbortOption</literal> value).
+            (<literal role="ndbapi">NdbOperation::AbortOption</literal>
+            value).
           </para>
 
           <note>

@@ -1060,20 +1066,18 @@
               <replaceable>abortOption</replaceable> was of type
               <literal>NdbTransaction::AbortOption</literal>; the
               <literal>AbortOption</literal> type became a member of
-              <literal>NdbOperation</literal> in MySQL Cluster NDB
-              6.2.0), and its default value was
-              <literal>NdbTransaction::AbortOnError</literal>. See
-              <xref linkend="ndb-ndboperation-abortoption"/>, for more
-              information.
+              <literal role="ndbapi">NdbOperation</literal> in MySQL
+              Cluster NDB 6.2.0), and its default value was
+              <literal>NdbTransaction::AbortOnError</literal>.
             </para>
           </note>
 
           <para>
             Beginning with MySQL Cluster NDB 6.2.0, errors arising from
             this method are found with
-            <literal>NdbOperation::getNdbError()</literal> rather than
-            <literal>NdbTransaction::getNdbError()</literal>. See
-            <xref linkend="ndb-ndboperation-getndberror"/>, for more
+            <literal role="ndbapi">NdbOperation::getNdbError()</literal>
+            rather than
+            <literal role="ndbapi">NdbTransaction::getNdbError()</literal>.
             information.
           </para>
         </listitem>

@@ -1301,8 +1305,7 @@
 
         <para>
           This method closes a transaction. It is equivalent to calling
-          <literal>Ndb::closeTransaction()</literal> (see
-          <xref linkend="ndb-ndb-closetransaction"/>).
+          <literal role="ndbapi">Ndb::closeTransaction()</literal>.
         </para>
 
       </formalpara>

@@ -1640,7 +1643,7 @@
 
         <para>
           This method is used to obtain the most recent error
-          (<literal>NdbError</literal>).
+          (<literal role="ndbapi">NdbError</literal>).
         </para>
 
       </formalpara>

@@ -1675,8 +1678,8 @@
         <title>Return value</title>
 
         <para>
-          A reference to an <literal>NdbError</literal> object. See
-          <xref linkend="ndb-ndberror"/>.
+          A reference to an <literal role="ndbapi">NdbError</literal>
+          object.
         </para>
 
       </formalpara>

@@ -1729,10 +1732,9 @@
       <tip>
         <para>
           To obtain more information about the actual error, use the
-          <literal>NdbOperation::getNdbError()</literal> method of the
-          <literal>NdbOperation</literal> object returned by
-          <literal>getNdbErrorOperation()</literal>. (See
-          <xref linkend="ndb-ndboperation-getndberror"/>.)
+          <literal role="ndbapi">NdbOperation::getNdbError()</literal>
+          method of the <literal role="ndbapi">NdbOperation</literal>
+          object returned by <literal>getNdbErrorOperation()</literal>.
         </para>
       </tip>
 

@@ -1766,7 +1768,7 @@
         <title>Return value</title>
 
         <para>
-          A pointer to an <literal>NdbOperation</literal>.
+          A pointer to an <literal role="ndbapi">NdbOperation</literal>.
         </para>
 
       </formalpara>

@@ -1901,11 +1903,12 @@
 
       <para>
         <literal>NdbTransaction::getNextCompletedOperation(NULL)</literal>
-        returns the transaction's first <literal>NdbOperation</literal>
-        object;
+        returns the transaction's first
+        <literal role="ndbapi">NdbOperation</literal> object;
         <literal>NdbTransaction::getNextCompletedOperation(<replaceable>myOp</replaceable>)</literal>
-        returns the <literal>NdbOperation</literal> object defined after
-        <literal>NdbOperation</literal> <replaceable>myOp</replaceable>.
+        returns the <literal role="ndbapi">NdbOperation</literal> object
+        defined after <literal role="ndbapi">NdbOperation</literal>
+        <replaceable>myOp</replaceable>.
       </para>
 
       <important>

@@ -1937,7 +1940,7 @@
         <para>
           This method requires a single parameter
           <replaceable>op</replaceable>, which is an operation
-          (<literal>NdbOperation</literal> object), or
+          (<literal role="ndbapi">NdbOperation</literal> object), or
           <literal>NULL</literal>.
         </para>
 

@@ -1989,8 +1992,8 @@
         <title>Description</title>
 
         <para>
-          This method reads a tuple using <literal>NdbRecord</literal>
-          objects.
+          This method reads a tuple using
+          <literal role="ndbapi">NdbRecord</literal> objects.
         </para>
 
       </formalpara>

@@ -2032,11 +2035,12 @@
         <listitem>
           <para>
             <replaceable>key_rec</replaceable> is a pointer to an
-            <literal>NdbRecord</literal> for either a table or an index.
-            If on a table, then the operation uses a primary key; if on
-            an index, then the operation uses a unique key. In either
-            case, the <replaceable>key_rec</replaceable> must include
-            all columns of the key.
+            <literal role="ndbapi">NdbRecord</literal> for either a
+            table or an index. If on a table, then the operation uses a
+            primary key; if on an index, then the operation uses a
+            unique key. In either case, the
+            <replaceable>key_rec</replaceable> must include all columns
+            of the key.
           </para>
         </listitem>
 

@@ -2052,7 +2056,8 @@
         <listitem>
           <para>
             <replaceable>result_rec</replaceable> is a pointer to an
-            <literal>NdbRecord</literal> used to hold the result
+            <literal role="ndbapi">NdbRecord</literal> used to hold the
+            result
           </para>
         </listitem>
 

@@ -2084,14 +2089,14 @@
 
         <listitem>
           <para>
-            <literal><link linkend="ndb-operationoptions">OperationOptions</link></literal>
+            <literal role="ndbapi">OperationOptions</literal>
             (<replaceable>opts</replaceable>) can be used to provide
             more finely-grained control of operation definitions. An
-            <literal>OperationOptions</literal> structure is passed with
-            flags indicating which operation definition options are
-            present. Not all operation types support all operation
-            options; the options supported for each type of operation
-            are shown in the following table:
+            <literal role="ndbapi">OperationOptions</literal> structure
+            is passed with flags indicating which operation definition
+            options are present. Not all operation types support all
+            operation options; the options supported for each type of
+            operation are shown in the following table:
           </para>
 
           <informaltable>

@@ -2148,11 +2153,12 @@
             The optional <replaceable>sizeOfOptions</replaceable>
             parameter is used to preserve backward compatibility of this
             interface with previous definitions of the
-            <literal>OperationOptions</literal> structure. If an unusual
-            size is detected by the interface implementation, it can use
-            this to determine how to interpret the passed
-            <literal>OperationOptions</literal> structure. To enable
-            this functionality, the caller should pass
+            <literal role="ndbapi">OperationOptions</literal> structure.
+            If an unusual size is detected by the interface
+            implementation, it can use this to determine how to
+            interpret the passed
+            <literal role="ndbapi">OperationOptions</literal> structure.
+            To enable this functionality, the caller should pass
             <literal>sizeof(NdbOperation::OperationOptions)</literal>
             for the value of this argument.
           </para>

@@ -2165,8 +2171,7 @@
         <title>Return value</title>
 
         <para>
-          A pointer to the
-          <link linkend="ndb-ndboperation"><literal>NdbOperation</literal></link>
+          A pointer to the <literal role="ndbapi">NdbOperation</literal>
           representing this read operation (this can be used to check
           for errors).
         </para>

@@ -2212,11 +2217,12 @@
         <listitem>
           <para>
             <replaceable>key_rec</replaceable> is a pointer to an
-            <literal>NdbRecord</literal> for either a table or an index.
-            If on a table, then the operation uses a primary key; if on
-            an index, then the operation uses a unique key. In either
-            case, the <replaceable>key_rec</replaceable> must include
-            all columns of the key.
+            <literal role="ndbapi">NdbRecord</literal> for either a
+            table or an index. If on a table, then the operation uses a
+            primary key; if on an index, then the operation uses a
+            unique key. In either case, the
+            <replaceable>key_rec</replaceable> must include all columns
+            of the key.
           </para>
         </listitem>
 

@@ -2232,7 +2238,8 @@
         <listitem>
           <para>
             <replaceable>result_rec</replaceable> is a pointer to an
-            <literal>NdbRecord</literal> used to hold the result
+            <literal role="ndbapi">NdbRecord</literal> used to hold the
+            result
           </para>
         </listitem>
 

@@ -2269,8 +2276,9 @@
         <title>Return value (<quote>old</quote> version)</title>
 
         <para>
-          A pointer to the <literal>NdbOperation</literal> representing
-          this operation (this can be used to check for errors).
+          A pointer to the <literal role="ndbapi">NdbOperation</literal>
+          representing this operation (this can be used to check for
+          errors).
         </para>
 
       </formalpara>

@@ -2308,7 +2316,8 @@
         <title>Description</title>
 
         <para>
-          Inserts a tuple using <literal>NdbRecord</literal>.
+          Inserts a tuple using
+          <literal role="ndbapi">NdbRecord</literal>.
         </para>
 
       </formalpara>

@@ -2358,9 +2367,9 @@
             <listitem>
               <para>
                 A pointer to an
-                <link linkend="ndb-ndbrecord"><literal>NdbRecord</literal></link>
-                indicating the record
-                (<replaceable>key_rec</replaceable>) to be inserted.
+                <literal role="ndbapi">NdbRecord</literal> indicating
+                the record (<replaceable>key_rec</replaceable>) to be
+                inserted.
               </para>
             </listitem>
 

@@ -2374,9 +2383,9 @@
             <listitem>
               <para>
                 A pointer to an
-                <link linkend="ndb-ndbrecord"><literal>NdbRecord</literal></link>
-                indicating an attribute
-                (<replaceable>attr_rec</replaceable>) to be inserted.
+                <literal role="ndbapi">NdbRecord</literal> indicating an
+                attribute (<replaceable>attr_rec</replaceable>) to be
+                inserted.
               </para>
             </listitem>
 

@@ -2396,14 +2405,14 @@
 
             <listitem>
               <para>
-                <literal><link linkend="ndb-operationoptions">OperationOptions</link></literal>
+                <literal role="ndbapi">OperationOptions</literal>
                 (<replaceable>opts</replaceable>) can be used to provide
                 more finely-grained control of operation definitions. An
-                <literal>OperationOptions</literal> structure is passed
-                with flags indicating which operation definition options
-                are present. Not all operation types support all
-                operation options; for the options supported by each
-                type of operation, see
+                <literal role="ndbapi">OperationOptions</literal>
+                structure is passed with flags indicating which
+                operation definition options are present. Not all
+                operation types support all operation options; for the
+                options supported by each type of operation, see
                 <xref linkend="ndb-ndbtransaction-readtuple"/>.
               </para>
             </listitem>

@@ -2413,10 +2422,11 @@
                 The optional <replaceable>sizeOfOptions</replaceable>
                 parameter is used to preserve backward compatibility of
                 this interface with previous definitions of the
-                <literal>OperationOptions</literal> structure. If an
-                unusual size is detected by the interface
-                implementation, it can use this to determine how to
-                interpret the passed <literal>OperationOptions</literal>
+                <literal role="ndbapi">OperationOptions</literal>
+                structure. If an unusual size is detected by the
+                interface implementation, it can use this to determine
+                how to interpret the passed
+                <literal role="ndbapi">OperationOptions</literal>
                 structure. To enable this functionality, the caller
                 should pass
                 <literal>sizeof(NdbOperation::OperationOptions)</literal>

@@ -2431,11 +2441,12 @@
 
       <para>
         This method can also be called using a single
-        <link linkend="ndb-ndbrecord"><literal>NdbRecord</literal></link>
-        pointer and single <literal>char</literal> pointer
+        <literal role="ndbapi">NdbRecord</literal> pointer and single
+        <literal>char</literal> pointer
         (<replaceable>combined_rec</replaceable>,
         <replaceable>combined_row</replaceable>) where the single
-        NdbRecord represents record and attribute and data.
+        <literal role="ndbapi">NdbRecord</literal> represents record and
+        attribute and data.
       </para>
 
       <formalpara>

@@ -2444,8 +2455,8 @@
 
         <para>
           A <literal>const</literal> pointer to the
-          <link linkend="ndb-ndboperation"><literal>NdbOperation</literal></link>
-          representing this insert operation.
+          <literal role="ndbapi">NdbOperation</literal> representing
+          this insert operation.
         </para>
 
       </formalpara>

@@ -2486,8 +2497,9 @@
 
         <listitem>
           <para>
-            A pointer to an <literal>NdbRecord</literal> indicating the
-            <replaceable>record</replaceable> to be inserted.
+            A pointer to an <literal role="ndbapi">NdbRecord</literal>
+            indicating the <replaceable>record</replaceable> to be
+            inserted.
           </para>
         </listitem>
 

@@ -2512,8 +2524,9 @@
 
         <para>
           Prior to MySQL Cluster NDB 6.2.15 and 6.3.15, this method
-          returned a pointer to the <literal>NdbOperation</literal>
-          representing the insert operation.
+          returned a pointer to the
+          <literal role="ndbapi">NdbOperation</literal> representing the
+          insert operation.
         </para>
 
       </formalpara>

@@ -2551,7 +2564,8 @@
         <title>Description</title>
 
         <para>
-          Updates a tuple using an <literal>NdbRecord</literal> object.
+          Updates a tuple using an
+          <literal role="ndbapi">NdbRecord</literal> object.
         </para>
 
       </formalpara>

@@ -2593,11 +2607,12 @@
         <listitem>
           <para>
             <replaceable>key_rec</replaceable> is a pointer to an
-            <literal>NdbRecord</literal> for either a table or an index.
-            If on a table, then the operation uses a primary key; if on
-            an index, then the operation uses a unique key. In either
-            case, the <replaceable>key_rec</replaceable> must include
-            all columns of the key.
+            <literal role="ndbapi">NdbRecord</literal> for either a
+            table or an index. If on a table, then the operation uses a
+            primary key; if on an index, then the operation uses a
+            unique key. In either case, the
+            <replaceable>key_rec</replaceable> must include all columns
+            of the key.
           </para>
         </listitem>
 

@@ -2613,8 +2628,8 @@
         <listitem>
           <para>
             <replaceable>attr_rec</replaceable> is an
-            <literal>NdbRecord</literal> referencing the attribute to be
-            updated.
+            <literal role="ndbapi">NdbRecord</literal> referencing the
+            attribute to be updated.
           </para>
 
           <note>

@@ -2644,13 +2659,13 @@
 
         <listitem>
           <para>
-            <literal><link linkend="ndb-operationoptions">OperationOptions</link></literal>
+            <literal role="ndbapi">OperationOptions</literal>
             (<replaceable>opts</replaceable>) can be used to provide
             more finely-grained control of operation definitions. An
-            <literal>OperationOptions</literal> structure is passed with
-            flags indicating which operation definition options are
-            present. Not all operation types support all operation
-            options; for the options supported by each type of
+            <literal role="ndbapi">OperationOptions</literal> structure
+            is passed with flags indicating which operation definition
+            options are present. Not all operation types support all
+            operation options; for the options supported by each type of
             operation, see
             <xref linkend="ndb-ndbtransaction-readtuple"/>.
           </para>

@@ -2661,11 +2676,12 @@
             The optional <replaceable>sizeOfOptions</replaceable>
             parameter is used to preserve backward compatibility of this
             interface with previous definitions of the
-            <literal>OperationOptions</literal> structure. If an unusual
-            size is detected by the interface implementation, it can use
-            this to determine how to interpret the passed
-            <literal>OperationOptions</literal> structure. To enable
-            this functionality, the caller should pass
+            <literal role="ndbapi">OperationOptions</literal> structure.
+            If an unusual size is detected by the interface
+            implementation, it can use this to determine how to
+            interpret the passed
+            <literal role="ndbapi">OperationOptions</literal> structure.
+            To enable this functionality, the caller should pass
             <literal>sizeof(NdbOperation::OperationOptions)</literal>
             for the value of this argument.
           </para>

@@ -2678,8 +2694,8 @@
         <title>Return value</title>
 
         <para>
-          The <literal>NdbOperation</literal> representing this
-          operation (can be used to check for errors).
+          The <literal role="ndbapi">NdbOperation</literal> representing
+          this operation (can be used to check for errors).
         </para>
 
       </formalpara>

@@ -2723,11 +2739,12 @@
         <listitem>
           <para>
             <replaceable>key_rec</replaceable> is a pointer to an
-            <literal>NdbRecord</literal> for either a table or an index.
-            If on a table, then the operation uses a primary key; if on
-            an index, then the operation uses a unique key. In either
-            case, the <replaceable>key_rec</replaceable> must include
-            all columns of the key.
+            <literal role="ndbapi">NdbRecord</literal> for either a
+            table or an index. If on a table, then the operation uses a
+            primary key; if on an index, then the operation uses a
+            unique key. In either case, the
+            <replaceable>key_rec</replaceable> must include all columns
+            of the key.
           </para>
         </listitem>
 

@@ -2743,8 +2760,8 @@
         <listitem>
           <para>
             <replaceable>attr_rec</replaceable> is an
-            <literal>NdbRecord</literal> referencing the attribute to be
-            updated.
+            <literal role="ndbapi">NdbRecord</literal> referencing the
+            attribute to be updated.
           </para>
 
           <note>

@@ -2780,9 +2797,9 @@
 
         <para>
           Prior to MySQL Cluster NDB 6.2.15 and 6.3.15, this method
-          returned a pointer to the <literal>NdbOperation</literal>
-          representing this operation (which could be used to check for
-          errors).
+          returned a pointer to the
+          <literal role="ndbapi">NdbOperation</literal> representing
+          this operation (which could be used to check for errors).
         </para>
 
       </formalpara>

@@ -2820,8 +2837,9 @@
         <title>Description</title>
 
         <para>
-          This method is used with <literal>NdbRecord</literal> to write
-          a tuple of data.
+          This method is used with
+          <literal role="ndbapi">NdbRecord</literal> to write a tuple of
+          data.
         </para>
 
       </formalpara>

@@ -2862,11 +2880,12 @@
         <listitem>
           <para>
             <replaceable>key_rec</replaceable> is a pointer to an
-            <literal>NdbRecord</literal> for either a table or an index.
-            If on a table, then the operation uses a primary key; if on
-            an index, then the operation uses a unique key. In either
-            case, the <replaceable>key_rec</replaceable> must include
-            all columns of the key.
+            <literal role="ndbapi">NdbRecord</literal> for either a
+            table or an index. If on a table, then the operation uses a
+            primary key; if on an index, then the operation uses a
+            unique key. In either case, the
+            <replaceable>key_rec</replaceable> must include all columns
+            of the key.
           </para>
         </listitem>
 

@@ -2882,8 +2901,8 @@
         <listitem>
           <para>
             <replaceable>attr_rec</replaceable> is an
-            <literal>NdbRecord</literal> referencing the attribute to be
-            written.
+            <literal role="ndbapi">NdbRecord</literal> referencing the
+            attribute to be written.
           </para>
 
           <note>

@@ -2913,13 +2932,13 @@
 
         <listitem>
           <para>
-            <literal><link linkend="ndb-operationoptions">OperationOptions</link></literal>
+            <literal role="ndbapi">OperationOptions</literal>
             (<replaceable>opts</replaceable>) can be used to provide
             more finely-grained control of operation definitions. An
-            <literal>OperationOptions</literal> structure is passed with
-            flags indicating which operation definition options are
-            present. Not all operation types support all operation
-            options; for the options supported by each type of
+            <literal role="ndbapi">OperationOptions</literal> structure
+            is passed with flags indicating which operation definition
+            options are present. Not all operation types support all
+            operation options; for the options supported by each type of
             operation, see
             <xref linkend="ndb-ndbtransaction-readtuple"/>.
           </para>

@@ -2930,11 +2949,12 @@
             The optional <replaceable>sizeOfOptions</replaceable>
             parameter is used to provide backward compatibility of this
             interface with previous definitions of the
-            <literal>OperationOptions</literal> structure. If an unusual
-            size is detected by the interface implementation, it can use
-            this to determine how to interpret the passed
-            <literal>OperationOptions</literal> structure. To enable
-            this functionality, the caller should pass
+            <literal role="ndbapi">OperationOptions</literal> structure.
+            If an unusual size is detected by the interface
+            implementation, it can use this to determine how to
+            interpret the passed
+            <literal role="ndbapi">OperationOptions</literal> structure.
+            To enable this functionality, the caller should pass
             <literal>sizeof(NdbOperation::OperationOptions)</literal>
             for the value of this argument.
           </para>

@@ -2948,9 +2968,9 @@
 
         <para>
           A <literal>const</literal> pointer to the
-          <literal>NdbOperation</literal> representing this write
-          operation. The operation can be checked for errors if and as
-          necessary.
+          <literal role="ndbapi">NdbOperation</literal> representing
+          this write operation. The operation can be checked for errors
+          if and as necessary.
         </para>
 
       </formalpara>

@@ -2993,11 +3013,12 @@
         <listitem>
           <para>
             <replaceable>key_rec</replaceable> is a pointer to an
-            <literal>NdbRecord</literal> for either a table or an index.
-            If on a table, then the operation uses a primary key; if on
-            an index, then the operation uses a unique key. In either
-            case, the <replaceable>key_rec</replaceable> must include
-            all columns of the key.
+            <literal role="ndbapi">NdbRecord</literal> for either a
+            table or an index. If on a table, then the operation uses a
+            primary key; if on an index, then the operation uses a
+            unique key. In either case, the
+            <replaceable>key_rec</replaceable> must include all columns
+            of the key.
           </para>
         </listitem>
 

@@ -3013,8 +3034,8 @@
         <listitem>
           <para>
             <replaceable>attr_rec</replaceable> is an
-            <literal>NdbRecord</literal> referencing the attribute to be
-            written.
+            <literal role="ndbapi">NdbRecord</literal> referencing the
+            attribute to be written.
           </para>
 
           <note>

@@ -3050,9 +3071,10 @@
 
         <para>
           Prior to MySQL Cluster NDB 6.2.15 and 6.3.15, this method
-          returned a pointer to the <literal>NdbOperation</literal>
-          representing this write operation. The operation could be
-          checked for errors if and as necessary.
+          returned a pointer to the
+          <literal role="ndbapi">NdbOperation</literal> representing
+          this write operation. The operation could be checked for
+          errors if and as necessary.
         </para>
 
       </formalpara>

@@ -3090,7 +3112,8 @@
         <title>Description</title>
 
         <para>
-          Deletes a tuple using <literal>NdbRecord</literal>.
+          Deletes a tuple using
+          <literal role="ndbapi">NdbRecord</literal>.
         </para>
 
       </formalpara>

@@ -3131,11 +3154,12 @@
         <listitem>
           <para>
             <replaceable>key_rec</replaceable> is a pointer to an
-            <literal>NdbRecord</literal> for either a table or an index.
-            If on a table, then the delete operation uses a primary key;
-            if on an index, then the operation uses a unique key. In
-            either case, the <replaceable>key_rec</replaceable> must
-            include all columns of the key.
+            <literal role="ndbapi">NdbRecord</literal> for either a
+            table or an index. If on a table, then the delete operation
+            uses a primary key; if on an index, then the operation uses
+            a unique key. In either case, the
+            <replaceable>key_rec</replaceable> must include all columns
+            of the key.
           </para>
         </listitem>
 

@@ -3159,13 +3183,13 @@
 
         <listitem>
           <para>
-            <literal><link linkend="ndb-operationoptions">OperationOptions</link></literal>
+            <literal role="ndbapi">OperationOptions</literal>
             (<replaceable>opts</replaceable>) can be used to provide
             more finely-grained control of operation definitions. An
-            <literal>OperationOptions</literal> structure is passed with
-            flags indicating which operation definition options are
-            present. Not all operation types support all operation
-            options; for the options supported by each type of
+            <literal role="ndbapi">OperationOptions</literal> structure
+            is passed with flags indicating which operation definition
+            options are present. Not all operation types support all
+            operation options; for the options supported by each type of
             operation, see
             <xref linkend="ndb-ndbtransaction-readtuple"/>.
           </para>

@@ -3176,11 +3200,12 @@
             The optional <replaceable>sizeOfOptions</replaceable>
             parameter provides backward compatibility of this interface
             with previous definitions of the
-            <literal>OperationOptions</literal> structure. If an unusual
-            size is detected by the interface implementation, it can use
-            this to determine how to interpret the passed
-            <literal>OperationOptions</literal> structure. To enable
-            this functionality, the caller should pass
+            <literal role="ndbapi">OperationOptions</literal> structure.
+            If an unusual size is detected by the interface
+            implementation, it can use this to determine how to
+            interpret the passed
+            <literal role="ndbapi">OperationOptions</literal> structure.
+            To enable this functionality, the caller should pass
             <literal>sizeof(NdbOperation::OperationOptions)</literal>
             for the value of this argument.
           </para>

@@ -3194,9 +3219,9 @@
 
         <para>
           A <literal>const</literal> pointer to the
-          <literal>NdbOperation</literal> representing this write
-          operation. The operation can be checked for errors if
-          necessary.
+          <literal role="ndbapi">NdbOperation</literal> representing
+          this write operation. The operation can be checked for errors
+          if necessary.
         </para>
 
       </formalpara>

@@ -3236,11 +3261,12 @@
         <listitem>
           <para>
             <replaceable>key_rec</replaceable> is a pointer to an
-            <literal>NdbRecord</literal> for either a table or an index.
-            If on a table, then the delete operation uses a primary key;
-            if on an index, then the operation uses a unique key. In
-            either case, the <replaceable>key_rec</replaceable> must
-            include all columns of the key.
+            <literal role="ndbapi">NdbRecord</literal> for either a
+            table or an index. If on a table, then the delete operation
+            uses a primary key; if on an index, then the operation uses
+            a unique key. In either case, the
+            <replaceable>key_rec</replaceable> must include all columns
+            of the key.
           </para>
         </listitem>
 

@@ -3260,9 +3286,9 @@
         <title>Return Value (<quote>old</quote> version)</title>
 
         <para>
-          A pointer to the <literal>NdbOperation</literal> representing
-          this write operation. The operation can be checked for errors
-          if necessary.
+          A pointer to the <literal role="ndbapi">NdbOperation</literal>
+          representing this write operation. The operation can be
+          checked for errors if necessary.
         </para>
 
       </formalpara>

@@ -3301,7 +3327,8 @@
 
         <para>
           This method performs a table scan, using an
-          <literal>NdbRecord</literal> object to read out column data.
+          <literal role="ndbapi">NdbRecord</literal> object to read out
+          column data.
         </para>
 
       </formalpara>

@@ -3341,9 +3368,11 @@
 
         <listitem>
           <para>
-            A pointer to an <literal>NdbRecord</literal> for storing the
-            result. This <replaceable>result_record</replaceable> must
-            remain valid until after the <literal>execute()</literal>
+            A pointer to an <literal role="ndbapi">NdbRecord</literal>
+            for storing the result. This
+            <replaceable>result_record</replaceable> must remain valid
+            until after the
+            <literal role="ndbapi:NdbTransaction">execute()</literal>
             call has been made.
           </para>
         </listitem>

@@ -3402,9 +3431,10 @@
         <title>Return value</title>
 
         <para>
-          A pointer to the <literal>NdbScanOperation</literal>
-          representing this scan. The operation can be checked for
-          errors if necessary.
+          A pointer to the
+          <literal role="ndbapi">NdbScanOperation</literal> representing
+          this scan. The operation can be checked for errors if
+          necessary.
         </para>
 
       </formalpara>

@@ -3443,8 +3473,8 @@
 
         <para>
           This method is used to perform an index scan of a table, using
-          <literal>NdbRecord</literal>. The scan may optionally be
-          ordered.
+          <literal role="ndbapi">NdbRecord</literal>. The scan may
+          optionally be ordered.
         </para>
 
       </formalpara>

@@ -3486,10 +3516,11 @@
           pointer as <replaceable>low_key</replaceable> and
           <replaceable>high_key</replaceable> in order to specify an
           equals bound; it is also permissible to reuse the rows after
-          the <literal>scanIndex()</literal> method
-          returns&mdash;thatis, they need not remain valid until
-          <literal>execute()</literal> time (unlike the
-          <literal>NdbRecord</literal> pointers).
+          the <literal>scanIndex()</literal> method returns&mdash;that
+          is, they need not remain valid until
+          <literal role="ndbapi:NdbTransaction">execute()</literal> time
+          (unlike the <literal role="ndbapi">NdbRecord</literal>
+          pointers).
         </para>
       </note>
 

@@ -3627,7 +3658,8 @@
         <title>Return value</title>
 
         <para>
-          The current <literal>NdbIndexScanOperation</literal>, which
+          The current
+          <literal role="ndbapi">NdbIndexScanOperation</literal>, which
           can be used for error checking.
         </para>
 


Modified: trunk/ndbapi/ndb-object.xml
===================================================================
--- trunk/ndbapi/ndb-object.xml	2010-11-25 11:57:00 UTC (rev 24017)
+++ trunk/ndbapi/ndb-object.xml	2010-11-25 12:49:27 UTC (rev 24018)
Changed blocks: 11, Lines Added: 25, Lines Deleted: 24; 3986 bytes

@@ -25,7 +25,7 @@
     <title>Parent class</title>
 
     <para>
-      <link linkend="ndb-ndbdictionary">NdbDictionary</link>
+      <literal role="ndbapi">NdbDictionary</literal>
     </para>
 
   </formalpara>

@@ -35,13 +35,13 @@
     <title>Child classes</title>
 
     <para>
-      <link linkend="ndb-datafile">Datafile</link>,
-      <link linkend="ndb-event">Event</link>,
-      <link linkend="ndb-index">Index</link>,
-      <link linkend="ndb-logfilegroup">LogfileGroup</link>,
-      <link linkend="ndb-table">Table</link>,
-      <link linkend="ndb-tablespace">Tablespace</link>,
-      <link linkend="ndb-undofile">Undofile</link>
+      <literal role="ndbapi">Datafile</literal>,
+      <literal role="ndbapi">Event</literal>,
+      <literal role="ndbapi">Index</literal>,
+      <literal role="ndbapi">LogfileGroup</literal>,
+      <literal role="ndbapi">Table</literal>,
+      <literal role="ndbapi">Tablespace</literal>,
+      <literal role="ndbapi">Undofile</literal>
     </para>
 
   </formalpara>

@@ -169,7 +169,7 @@
 
       <para>
         This section details the public enumerated types belonging to
-        the <literal>Object</literal> class.
+        the <literal role="ndbapi">Object</literal> class.
       </para>
 
     </abstract>

@@ -189,8 +189,8 @@
       <abstract>
 
         <para>
-          This type describes the <literal>Object</literal>'s
-          fragmentation type.
+          This type describes the
+          <literal role="ndbapi">Object</literal>'s fragmentation type.
         </para>
 
       </abstract>

@@ -268,7 +268,7 @@
 
         <para>
           This type describes the state of the
-          <literal>Object</literal>.
+          <literal role="ndbapi">Object</literal>.
         </para>
 
       </abstract>

@@ -356,7 +356,8 @@
       <abstract>
 
         <para>
-          This type describes the <literal>Object</literal>'s status.
+          This type describes the
+          <literal role="ndbapi">Object</literal>'s status.
         </para>
 
       </abstract>

@@ -439,8 +440,8 @@
       <abstract>
 
         <para>
-          This type describes the <literal>Object</literal>'s
-          persistence.
+          This type describes the
+          <literal role="ndbapi">Object</literal>'s persistence.
         </para>
 
       </abstract>

@@ -511,7 +512,8 @@
       <abstract>
 
         <para>
-          This type describes the <literal>Object</literal>'s type.
+          This type describes the
+          <literal role="ndbapi">Object</literal>'s type.
         </para>
 
       </abstract>

@@ -628,7 +630,7 @@
 
       <para>
         The sections that follow describe each of the public methods of
-        the <literal>Object</literal> class.
+        the <literal role="ndbapi">Object</literal> class.
       </para>
 
     </abstract>

@@ -636,10 +638,9 @@
     <important>
       <para>
         All 3 of these methods are pure virtual methods, and are
-        reimplemented in the <literal>Table</literal>,
-        <literal>Index</literal>, and <literal>Event</literal>
-        subclasses where needed. See <xref linkend="ndb-table"/>,
-        <xref linkend="ndb-index"/>, and <xref linkend="ndb-event"/>.
+        reimplemented in the <literal role="ndbapi">Table</literal>,
+        <literal role="ndbapi">Index</literal>, and
+        <literal role="ndbapi">Event</literal> subclasses where needed.
       </para>
     </important>
 

@@ -696,9 +697,9 @@
         <title>Return value</title>
 
         <para>
-          Returns the current <literal>Status</literal> of the
-          <literal>Object</literal>. For possible values, see
-          <xref linkend="ndb-object-status"/>.
+          Returns the current
+          <literal role="ndbapi:Object">Status</literal> of the
+          <literal role="ndbapi">Object</literal>.
         </para>
 
       </formalpara>


Modified: trunk/ndbapi/ndb-operationoptions.xml
===================================================================
--- trunk/ndbapi/ndb-operationoptions.xml	2010-11-25 11:57:00 UTC (rev 24017)
+++ trunk/ndbapi/ndb-operationoptions.xml	2010-11-25 12:49:27 UTC (rev 24018)
Changed blocks: 2, Lines Added: 12, Lines Deleted: 13; 2165 bytes

@@ -12,7 +12,7 @@
     <title>Parent class</title>
 
     <para>
-      <link linkend="ndb-ndboperation">NdbOperation</link>
+      <literal role="ndbapi">NdbOperation</literal>
     </para>
 
   </formalpara>

@@ -23,24 +23,23 @@
 
     <para>
       These options are passed to the
-      <link linkend="ndb-ndbrecord"><literal>NdbRecord</literal></link>-based
-      primary key and scan takeover operation methods defined in the
-      <literal><link linkend="ndb-ndbtransaction">NdbTransaction</link></literal>
-      and
-      <literal><link linkend="ndb-ndbscanoperation">NdbScanOperation</link></literal>
-      classes.
+      <literal role="ndbapi">NdbRecord</literal>-based primary key and
+      scan takeover operation methods defined in the
+      <literal role="ndbapi">NdbTransaction</literal> and
+      <literal role="ndbapi">NdbScanOperation</literal> classes.
     </para>
 
   </formalpara>
 
   <note>
     <para>
-      Most <literal>NdbTransaction::*Tuple()</literal> methods take a
-      supplementary <replaceable>sizeOfOptions</replaceable> parameter.
-      This is optional, and is intended to permit the interface
-      implementation to remain backward compatible with older
-      un-recompiled clients that may pass an older (smaller) version of
-      the <literal>OperationOptions</literal> structure. This effect is
+      Most <literal>NdbTransaction::*Tuple()</literal> methods (see
+      <xref linkend="ndb-ndbtransaction-methods"/>) take a supplementary
+      <replaceable>sizeOfOptions</replaceable> parameter. This is
+      optional, and is intended to permit the interface implementation
+      to remain backward compatible with older un-recompiled clients
+      that may pass an older (smaller) version of the
+      <literal>OperationOptions</literal> structure. This effect is
       achieved by passing <literal>sizeof(OperationOptions)</literal>
       into this parameter.
     </para>


Modified: trunk/ndbapi/ndb-partitionspec.xml
===================================================================
--- trunk/ndbapi/ndb-partitionspec.xml	2010-11-25 11:57:00 UTC (rev 24017)
+++ trunk/ndbapi/ndb-partitionspec.xml	2010-11-25 12:49:27 UTC (rev 24018)
Changed blocks: 4, Lines Added: 7, Lines Deleted: 8; 1924 bytes

@@ -29,7 +29,7 @@
     <title>Parent class</title>
 
     <para>
-      <link linkend="ndb-ndb">Ndb</link>
+      <literal role="ndbapi">Ndb</literal>
     </para>
 
   </formalpara>

@@ -66,8 +66,8 @@
     <listitem>
       <para>
         (<emphasis>MySQL Cluster NDB 7.0.4 and later</emphasis>:) A row
-        in <literal>NdbRecord</literal> format containing a natively
-        partitioned table&apos;s distribution key values.
+        in <literal role="ndbapi">NdbRecord</literal> format containing
+        a natively partitioned table&apos;s distribution key values.
       </para>
     </listitem>
 

@@ -129,7 +129,7 @@
           <entry><link linkend="ndb-partitionspec-keyrecord"><literal>KeyRecord</literal></link></entry>
           <entry>The partition is identified using a natively partitioned table&apos;s
             distribution key values, as contained in a row given in
-            <literal>NdbRecord</literal> format.</entry>
+            <literal role="ndbapi">NdbRecord</literal> format.</entry>
         </row>
       </tbody>
     </tgroup>

@@ -240,10 +240,9 @@
       <tbody>
         <row>
           <entry><literal>keyRecord</literal></entry>
-          <entry><literal>const NdbRecord*</literal> (see
-            <xref linkend="ndb-ndbrecord"/>)</entry>
-          <entry>A row in <literal>NdbRecord</literal> format, containing a table&apos;s
-            distribution keys.</entry>
+          <entry><literal>const NdbRecord*</literal></entry>
+          <entry>A row in <literal role="ndbapi">NdbRecord</literal> format, containing a
+            table&apos;s distribution keys.</entry>
         </row>
         <row>
           <entry><literal>keyRow</literal></entry>


Modified: trunk/ndbapi/ndb-recordspecification.xml
===================================================================
--- trunk/ndbapi/ndb-recordspecification.xml	2010-11-25 11:57:00 UTC (rev 24017)
+++ trunk/ndbapi/ndb-recordspecification.xml	2010-11-25 12:49:27 UTC (rev 24018)
Changed blocks: 3, Lines Added: 5, Lines Deleted: 5; 1414 bytes

@@ -12,7 +12,7 @@
     <title>Parent class</title>
 
     <para>
-      <link linkend="ndb-ndbdictionary">NdbDictionary</link>
+      <literal role="ndbapi">NdbDictionary</literal>
     </para>
 
   </formalpara>

@@ -23,7 +23,7 @@
 
     <para>
       This structure is used to specify columns and range offsets when
-      creating <literal>NdbRecord</literal> objects.
+      creating <literal role="ndbapi">NdbRecord</literal> objects.
     </para>
 
   </formalpara>

@@ -71,9 +71,9 @@
           <entry><literal>const Column *</literal></entry>
           <entry>The column described by this entry (the column's maximum size defines
             the field size for the row). Even when creating an
-            <literal>NdbRecord</literal> for an index, this must point
-            to a column obtained from the underlying table, and not from
-            the index itself.</entry>
+            <literal role="ndbapi">NdbRecord</literal> for an index,
+            this must point to a column obtained from the underlying
+            table, and not from the index itself.</entry>
         </row>
         <row>
           <entry><literal>offset</literal></entry>


Modified: trunk/ndbapi/ndb-scanoptions.xml
===================================================================
--- trunk/ndbapi/ndb-scanoptions.xml	2010-11-25 11:57:00 UTC (rev 24017)
+++ trunk/ndbapi/ndb-scanoptions.xml	2010-11-25 12:49:27 UTC (rev 24018)
Changed blocks: 2, Lines Added: 9, Lines Deleted: 10; 1667 bytes

@@ -12,7 +12,7 @@
     <title>Parent class</title>
 
     <para>
-      <link linkend="ndb-ndbscanoperation">NdbScanOperation</link>
+      <literal role="ndbapi">NdbScanOperation</literal>
     </para>
 
   </formalpara>

@@ -23,15 +23,14 @@
 
     <para>
       This data structure is used to pass options to the
-      <literal><link linkend="ndb-ndbrecord">NdbRecord</link></literal>-based
-      <literal>scanTable()</literal> and <literal>scanIndex()</literal>
-      methods of the <literal>NdbTransaction</literal> class (see
-      <xref linkend="ndb-ndbtransaction-scantable"/>, and
-      <xref linkend="ndb-ndbtransaction-scanindex"/>). Each option type
-      is marked as present by setting the corresponding bit in the
-      <literal>optionsPresent</literal> field. Only the option types
-      marked in the <literal>optionsPresent</literal> field need have
-      sensible data.
+      <literal role="ndbapi">NdbRecord</literal>-based
+      <literal role="ndbapi:NdbTransaction">scanTable()</literal> and
+      <literal role="ndbapi:NdbTransaction">scanIndex()</literal>
+      methods of the <literal role="ndbapi">NdbTransaction</literal>
+      class. Each option type is marked as present by setting the
+      corresponding bit in the <literal>optionsPresent</literal> field.
+      Only the option types marked in the
+      <literal>optionsPresent</literal> field need have sensible data.
     </para>
 
   </formalpara>


Modified: trunk/ndbapi/ndb-setvaluespec.xml
===================================================================
--- trunk/ndbapi/ndb-setvaluespec.xml	2010-11-25 11:57:00 UTC (rev 24017)
+++ trunk/ndbapi/ndb-setvaluespec.xml	2010-11-25 12:49:27 UTC (rev 24018)
Changed blocks: 3, Lines Added: 3, Lines Deleted: 6; 1283 bytes

@@ -12,7 +12,7 @@
     <title>Parent class</title>
 
     <para>
-      <link linkend="ndb-ndboperation">NdbOperation</link>
+      <literal role="ndbapi">NdbOperation</literal>
     </para>
 
   </formalpara>

@@ -23,9 +23,7 @@
 
     <para>
       This structure is used to specify an extra value to set as part of
-      an
-      <link linkend="ndb-ndbrecord"><literal>NdbRecord</literal></link>
-      operation.
+      an <literal role="ndbapi">NdbRecord</literal> operation.
     </para>
 
   </formalpara>

@@ -69,8 +67,7 @@
       <tbody>
         <row>
           <entry><literal>column</literal></entry>
-          <entry><literal>const
-            <link linkend="ndb-column"><literal>NdbDictionary::Column</literal></link>*</literal></entry>
+          <entry><literal>const <literal role="ndbapi">Column</literal>*</literal></entry>
           <entry>To specify an extra value to read, the caller must provide this, as well
             as (optionally <literal>NULL</literal>)
             <replaceable>appStorage</replaceable> pointer.</entry>


Modified: trunk/ndbapi/ndb-table.xml
===================================================================
--- trunk/ndbapi/ndb-table.xml	2010-11-25 11:57:00 UTC (rev 24017)
+++ trunk/ndbapi/ndb-table.xml	2010-11-25 12:49:27 UTC (rev 24018)
Changed blocks: 20, Lines Added: 45, Lines Deleted: 40; 7934 bytes

@@ -25,7 +25,7 @@
     <title>Parent class</title>
 
     <para>
-      <link linkend="ndb-ndbdictionary">NdbDictionary</link>
+      <literal role="ndbapi">NdbDictionary</literal>
     </para>
 
   </formalpara>

@@ -46,9 +46,10 @@
 
     <para>
       The <literal>Table</literal> class represents a table in a MySQL
-      Cluster database. This class extends the <literal>Object</literal>
-      class, which in turn is an inner class of the
-      <literal>NdbDictionary</literal> class.
+      Cluster database. This class extends the
+      <literal role="ndbapi">Object</literal> class, which in turn is an
+      inner class of the <literal role="ndbapi">NdbDictionary</literal>
+      class.
     </para>
 
   </formalpara>

@@ -258,8 +259,8 @@
         </row>
         <row>
           <entry><literal><link linkend="ndb-table-getobjecttype">getObjectType()</link></literal></entry>
-          <entry>Gets the table's object type (<literal>Object::Type</literal> as opposed
-            to <literal>Table::Type</literal>)</entry>
+          <entry>Gets the table's object type
+            (<literal role="ndbapi">Object::Type</literal>)</entry>
         </row>
         <row>
           <entry><literal><link linkend="ndb-table-getobjectstatus">getObjectStatus()</link></literal></entry>

@@ -401,8 +402,7 @@
 
     <para>
       The <literal>Table</literal> class defines a single public type
-      <literal>SingleUserMode</literal>. For more information, see
-      <xref linkend="ndb-table-singleusermode"/>.
+      <literal role="ndbapi:Table">SingleUserMode</literal>.
     </para>
 
   </formalpara>

@@ -499,7 +499,7 @@
 
       <para>
         This section discusses the public methods of the
-        <literal>Table</literal> class.
+        <literal role="ndbapi">Table</literal> class.
       </para>
 
     </abstract>

@@ -513,14 +513,15 @@
 
     <warning>
       <para>
-        As with other database objects, <literal>Table</literal> object
-        creation and attribute changes to existing tables done using the
-        NDB API are not visible from MySQL. For example, if you add a
-        new column to a table using
-        <literal>Table::addColumn()</literal>, MySQL will not see the
-        new column. The only exception to this rule with regard to
-        tables is that you can change the name of an existing table
-        using <literal>Table::setName()</literal>.
+        As with other database objects,
+        <literal role="ndbapi">Table</literal> object creation and
+        attribute changes to existing tables done using the NDB API are
+        not visible from MySQL. For example, if you add a new column to
+        a table using
+        <literal role="ndbapi">Table::addColumn()</literal>, MySQL will
+        not see the new column. The only exception to this rule with
+        regard to tables is that you can change the name of an existing
+        table using <literal role="ndbapi">Table::setName()</literal>.
       </para>
     </warning>
 

@@ -533,8 +534,9 @@
         <title>Description</title>
 
         <para>
-          Creates a <literal>Table</literal> instance. There are two
-          version of the <literal>Table</literal> constructor, one for
+          Creates a <literal role="ndbapi">Table</literal> instance.
+          There are two version of the
+          <literal role="ndbapi">Table</literal> constructor, one for
           creating a new instance, and a copy constructor.
         </para>
 

@@ -591,7 +593,7 @@
         <title>Return value</title>
 
         <para>
-          A <literal>Table</literal> object.
+          A <literal role="ndbapi">Table</literal> object.
         </para>
 
       </formalpara>

@@ -1473,7 +1475,7 @@
 
         <para>
           This method is used to compare one instance of
-          <literal>Table</literal> with another.
+          <literal role="ndbapi">Table</literal> with another.
         </para>
 
       </formalpara>

@@ -1498,8 +1500,8 @@
         <title>Parameters</title>
 
         <para>
-          A reference to the <literal>Table</literal> object with which
-          the current instance is to be compared.
+          A reference to the <literal role="ndbapi">Table</literal>
+          object with which the current instance is to be compared.
         </para>
 
       </formalpara>

@@ -2512,9 +2514,8 @@
         <listitem>
           <para>
             When <literal>getTablespace()</literal> is called without
-            any arguments, it returns a <literal>Tablespace</literal>
-            object instance. See <xref linkend="ndb-tablespace"/>, for
-            more information.
+            any arguments, it returns a
+            <literal role="ndbapi">Tablespace</literal> object instance.
           </para>
         </listitem>
 

@@ -2563,7 +2564,7 @@
 
         <para>
           This method is used to obtain the table's type&mdash;that is,
-          its <literal>Object::Type</literal> value
+          its <literal role="ndbapi">Object::Type</literal> value
         </para>
 
       </formalpara>

@@ -2638,7 +2639,7 @@
 
         <para>
           This method gets the table's status&mdash;that is, its
-          <literal>Object::Status</literal>.
+          <literal role="ndbapi">Object::Status</literal>.
         </para>
 
       </formalpara>

@@ -3312,7 +3313,8 @@
         <para>
           This is the only
           <literal>set<replaceable>*</replaceable>()</literal> method of
-          <literal>Table</literal> whose effects are visible to MySQL.
+          <literal role="ndbapi">Table</literal> whose effects are
+          visible to MySQL.
         </para>
       </note>
 

@@ -3421,7 +3423,7 @@
 
         <para>
           <emphasis>None</emphasis>; however, it does create a copy of
-          the original <literal>Column</literal> object.
+          the original <literal role="ndbapi">Column</literal> object.
         </para>
 
       </formalpara>

@@ -4014,7 +4016,7 @@
     )
 </programlisting>
 
-          Using a <literal>Tablespace</literal> object:
+          Using a <literal role="ndbapi">Tablespace</literal> object:
 
 <programlisting>
 void setTablespace

@@ -4048,8 +4050,8 @@
 
         <listitem>
           <para>
-            A reference to an existing <literal>Tablespace</literal>
-            instance.
+            A reference to an existing
+            <literal role="ndbapi">Tablespace</literal> instance.
           </para>
         </listitem>
 

@@ -5074,7 +5076,8 @@
         <title>Parameters</title>
 
         <para>
-          A reference to an <literal>NdbError</literal> object.
+          A reference to an <literal role="ndbapi">NdbError</literal>
+          object.
         </para>
 
       </formalpara>

@@ -5125,11 +5128,12 @@
         <para>
           This method validates the definition for a new table prior to
           its being created, and executes the
-          <literal>Table::aggregate()</literal> method, as well as
-          performing additional checks. <literal>validate()</literal> is
-          called automatically when a table is created or retrieved. For
-          this reason, it is usually not necessary to call
-          <literal>aggregate()</literal> or
+          <literal role="ndbapi">Table::aggregate()</literal> method, as
+          well as performing additional checks.
+          <literal>validate()</literal> is called automatically when a
+          table is created or retrieved. For this reason, it is usually
+          not necessary to call
+          <literal role="ndbapi:Table">aggregate()</literal> or
           <literal>validate()</literal> directly.
         </para>
 

@@ -5170,7 +5174,8 @@
         <title>Parameters</title>
 
         <para>
-          A reference to an <literal>NdbError</literal> object.
+          A reference to an <literal role="ndbapi">NdbError</literal>
+          object.
         </para>
 
       </formalpara>


Modified: trunk/ndbapi/ndb-tablespace.xml
===================================================================
--- trunk/ndbapi/ndb-tablespace.xml	2010-11-25 11:57:00 UTC (rev 24017)
+++ trunk/ndbapi/ndb-tablespace.xml	2010-11-25 12:49:27 UTC (rev 24018)
Changed blocks: 10, Lines Added: 17, Lines Deleted: 19; 3759 bytes

@@ -25,7 +25,7 @@
     <title>Parent class</title>
 
     <para>
-      <link linkend="ndb-ndbdictionary">NdbDictionary</link>
+      <literal role="ndbapi">NdbDictionary</literal>
     </para>
 
   </formalpara>

@@ -124,8 +124,8 @@
         </row>
         <row>
           <entry><literal><link linkend="ndb-tablespace-getobjectstatus">getObjectStatus()</link></literal></entry>
-          <entry>Used to obtain the <literal>Object::Status</literal> of the
-            <literal>Tablespace</literal> instance for which it is
+          <entry>Used to obtain the <literal role="ndbapi">Object::Status</literal> of
+            the <literal>Tablespace</literal> instance for which it is
             called</entry>
         </row>
         <row>

@@ -169,9 +169,8 @@
     <para>
       The Tablespace class defines no public types of its own; however,
       two of its methods make use of the
-      <literal>AutoGrowSpecification</literal> data structure.
-      Information about this structure can be found in
-      <xref linkend="ndb-autogrowspecification"/>.
+      <literal role="ndbapi">AutoGrowSpecification</literal> data
+      structure.
     </para>
 
   </formalpara>

@@ -205,7 +204,7 @@
 
       <para>
         This section provides details of the public members of the NDB
-        API's <literal>Tablespace</literal> class.
+        API's <literal role="ndbapi">Tablespace</literal> class.
       </para>
 
     </abstract>

@@ -220,16 +219,16 @@
 
         <para>
           These methods are used to create a new instance of
-          <literal>Tablespace</literal>, or to copy an existing one.
+          <literal role="ndbapi">Tablespace</literal>, or to copy an
+          existing one.
         </para>
 
       </formalpara>
 
       <note>
         <para>
-          The <literal>NdbDictionary::Dictionary</literal> class also
-          supplies methods for creating and dropping tablespaces. See
-          <xref linkend="ndb-dictionary"/>.
+          The <literal role="ndbapi">Dictionary</literal> class also
+          supplies methods for creating and dropping tablespaces.
         </para>
       </note>
 

@@ -267,8 +266,8 @@
 
         <para>
           New instance: <emphasis>None</emphasis>. Copy constructor: a
-          reference to an existing <literal>Tablespace</literal>
-          instance.
+          reference to an existing
+          <literal role="ndbapi">Tablespace</literal> instance.
         </para>
 
       </formalpara>

@@ -278,7 +277,7 @@
         <title>Return value</title>
 
         <para>
-          A <literal>Tablespace</literal> object.
+          A <literal role="ndbapi">Tablespace</literal> object.
         </para>
 
       </formalpara>

@@ -760,8 +759,7 @@
         <title>Return value</title>
 
         <para>
-          An <literal>Object::Status</literal> value; see
-          <xref linkend="ndb-object-status"/>, for details.
+          An <literal role="ndbapi">Object::Status</literal> value.
         </para>
 
       </formalpara>

@@ -1120,8 +1118,8 @@
 
         <para>
           This method takes a single parameter, an
-          <literal>AutoGrowSpecification</literal> data structure. See
-          <xref linkend="ndb-autogrowspecification"/>.
+          <literal role="ndbapi">AutoGrowSpecification</literal> data
+          structure.
         </para>
 
       </formalpara>

@@ -1195,7 +1193,7 @@
 
       <para>
         This method can also be called by passing it a reference to a
-        <literal>LogfileGroup</literal> object:
+        <literal role="ndbapi">LogfileGroup</literal> object:
       </para>
 
 <programlisting>


Modified: trunk/ndbapi/ndb-undofile.xml
===================================================================
--- trunk/ndbapi/ndb-undofile.xml	2010-11-25 11:57:00 UTC (rev 24017)
+++ trunk/ndbapi/ndb-undofile.xml	2010-11-25 12:49:27 UTC (rev 24018)
Changed blocks: 10, Lines Added: 13, Lines Deleted: 13; 3274 bytes

@@ -25,7 +25,7 @@
     <title>Parent class</title>
 
     <para>
-      <link linkend="ndb-ndbdictionary">NdbDictionary</link>
+      <literal role="ndbapi">NdbDictionary</literal>
     </para>
 
   </formalpara>

@@ -45,8 +45,9 @@
     <title>Description</title>
 
     <para>
-      The <literal>Undofile</literal> class models a Cluster Disk Data
-      undofile, which stores data used for rolling back transactions.
+      The <literal>Undofile</literal> class models a MySQL Cluster Disk
+      Data undofile, which stores data used for rolling back
+      transactions.
     </para>
 
   </formalpara>

@@ -146,7 +147,7 @@
           <entry><literal><link linkend="ndb-undofile-setlogfilegroup">setLogfileGroup()</link></literal></entry>
           <entry>Sets the undo file's log file group using the name of the log file group
             or a reference to the corresponding
-            <literal>LogfileGroup</literal> object</entry>
+            <literal role="ndbapi">LogfileGroup</literal> object</entry>
         </row>
         <row>
           <entry><literal><link linkend="ndb-undofile-setnode">setNode()</link></literal></entry>

@@ -200,7 +201,7 @@
 
       <para>
         This section details the public methods of the
-        <literal>Undofile</literal> class.
+        <literal role="ndbapi">Undofile</literal> class.
       </para>
 
     </abstract>

@@ -215,8 +216,8 @@
 
         <para>
           The class constructor can be used to create a new
-          <literal>Undofile</literal> instance, or to copy an existing
-          one.
+          <literal role="ndbapi">Undofile</literal> instance, or to copy
+          an existing one.
         </para>
 
       </formalpara>

@@ -256,7 +257,7 @@
         <para>
           New instance: <emphasis>None</emphasis>. The copy constructor
           takes a single argument&mdash;a reference to the
-          <literal>Undofile</literal> object to be copied.
+          <literal role="ndbapi">Undofile</literal> object to be copied.
         </para>
 
       </formalpara>

@@ -266,7 +267,7 @@
         <title>Return value</title>
 
         <para>
-          An <literal>Undofile</literal> object.
+          An <literal role="ndbapi">Undofile</literal> object.
         </para>
 
       </formalpara>

@@ -803,8 +804,7 @@
         <title>Return value</title>
 
         <para>
-          An <literal>Object::Status</literal> value; see
-          <xref linkend="ndb-object-status"/>, for more information.
+          An <literal role="ndbapi">Object::Status</literal> value.
         </para>
 
       </formalpara>

@@ -1162,7 +1162,7 @@
 
       <para>
         Using a reference to an instance of
-        <literal>LogfileGroup</literal>:
+        <literal role="ndbapi">LogfileGroup</literal>:
       </para>
 
 <programlisting>

@@ -1179,7 +1179,7 @@
         <para>
           The <replaceable>name</replaceable> of the log file group (a
           character pointer), or a reference to a
-          <literal>LogfileGroup</literal> instance.
+          <literal role="ndbapi">LogfileGroup</literal> instance.
         </para>
 
       </formalpara>


Modified: trunk/ndbapi/overview.xml
===================================================================
--- trunk/ndbapi/overview.xml	2010-11-25 11:57:00 UTC (rev 24017)
+++ trunk/ndbapi/overview.xml	2010-11-25 12:49:27 UTC (rev 24018)
Changed blocks: 48, Lines Added: 215, Lines Deleted: 185; 40024 bytes

@@ -84,15 +84,15 @@
       <para>
         The NDB API provides a number of classes implementing the
         functionality described above. The most important of these
-        include the <literal>Ndb</literal>,
-        <literal>Ndb_cluster_connection</literal>,
-        <literal>NdbTransaction</literal>, and
-        <literal>NdbOperation</literal> classes. These model
-        (respectively) database connections, cluster connections,
+        include the <literal role="ndbapi">Ndb</literal>,
+        <literal role="ndbapi">Ndb_cluster_connection</literal>,
+        <literal role="ndbapi">NdbTransaction</literal>, and
+        <literal role="ndbapi">NdbOperation</literal> classes. These
+        model (respectively) database connections, cluster connections,
         transactions, and operations. These classes and their subclasses
         are listed in <xref linkend="ndb-classes"/>. Error conditions in
-        the NDB API are handled using <literal>NdbError</literal>, a
-        structure which is described in <xref linkend="ndb-ndberror"/>.
+        the NDB API are handled using the
+        <literal role="ndbapi">NdbError</literal> structure.
       </para>
 
     </section>

@@ -574,56 +574,56 @@
 
         <listitem>
           <para>
-            <link linkend="ndb-ndb-cluster-connection"><literal>Ndb_cluster_connection</literal></link>
+            <literal role="ndbapi">Ndb_cluster_connection</literal>
             represents a connection to a cluster.
           </para>
         </listitem>
 
         <listitem>
           <para>
-            <link linkend="ndb-ndb"><literal>Ndb</literal></link> is the
-            main class, and represents a connection to a database.
+            <literal role="ndbapi">Ndb</literal> is the main class, and
+            represents a connection to a database.
           </para>
         </listitem>
 
         <listitem>
           <para>
-            <link linkend="ndb-ndbdictionary"><literal>NdbDictionary</literal></link>
-            provides meta-information about tables and attributes.
+            <literal role="ndbapi">NdbDictionary</literal> provides
+            meta-information about tables and attributes.
           </para>
         </listitem>
 
         <listitem>
           <para>
-            <link linkend="ndb-ndbtransaction"><literal>NdbTransaction</literal></link>
-            represents a transaction.
+            <literal role="ndbapi">NdbTransaction</literal> represents a
+            transaction.
           </para>
         </listitem>
 
         <listitem>
           <para>
-            <link linkend="ndb-ndboperation"><literal>NdbOperation</literal></link>
-            represents an operation using a primary key.
+            <literal role="ndbapi">NdbOperation</literal> represents an
+            operation using a primary key.
           </para>
         </listitem>
 
         <listitem>
           <para>
-            <link linkend="ndb-ndbscanoperation"><literal>NdbScanOperation</literal></link>
-            represents an operation performing a full table scan.
+            <literal role="ndbapi">NdbScanOperation</literal> represents
+            an operation performing a full table scan.
           </para>
         </listitem>
 
         <listitem>
           <para>
-            <link linkend="ndb-ndbindexoperation"><literal>NdbIndexOperation</literal></link>
+            <literal role="ndbapi">NdbIndexOperation</literal>
             represents an operation using a unique hash index.
           </para>
         </listitem>
 
         <listitem>
           <para>
-            <link linkend="ndb-ndbindexscanoperation"><literal>NdbIndexScanOperation</literal></link>
+            <literal role="ndbapi">NdbIndexScanOperation</literal>
             represents an operation performing a scan using an ordered
             index.
           </para>

@@ -631,8 +631,8 @@
 
         <listitem>
           <para>
-            <link linkend="ndb-ndbrecattr"><literal>NdbRecAttr</literal></link>
-            represents an attribute value.
+            <literal role="ndbapi">NdbRecAttr</literal> represents an
+            attribute value.
           </para>
         </listitem>
 

@@ -640,15 +640,14 @@
 
       <para>
         In addition, the NDB API defines an
-        <link linkend="ndb-ndberror"><literal>NdbError</literal></link>
-        structure, which contains the specification for an error.
+        <literal role="ndbapi">NdbError</literal> structure, which
+        contains the specification for an error.
       </para>
 
       <para>
         It is also possible to receive events triggered when data in the
         database is changed. This is accomplished through the
-        <link linkend="ndb-ndbeventoperation"><literal>NdbEventOperation</literal></link>
-        class.
+        <literal role="ndbapi">NdbEventOperation</literal> class.
       </para>
 
       <para>

@@ -682,42 +681,46 @@
         <listitem>
           <para>
             Connect to a cluster using the
-            <literal>Ndb_cluster_connection</literal> object.
+            <literal role="ndbapi">Ndb_cluster_connection</literal>
+            object.
           </para>
         </listitem>
 
         <listitem>
           <para>
             Initiate a database connection by constructing and
-            initialising one or more <literal>Ndb</literal> objects.
+            initialising one or more
+            <literal role="ndbapi">Ndb</literal> objects.
           </para>
         </listitem>
 
         <listitem>
           <para>
             Identify the tables, columns, and indexes on which you wish
-            to operate, using <literal>NdbDictionary</literal> and one
-            or more of its subclasses.
+            to operate, using
+            <literal role="ndbapi">NdbDictionary</literal> and one or
+            more of its subclasses.
           </para>
         </listitem>
 
         <listitem>
           <para>
             Define and execute transactions using the
-            <literal>NdbTransaction</literal> class.
+            <literal role="ndbapi">NdbTransaction</literal> class.
           </para>
         </listitem>
 
         <listitem>
           <para>
-            Delete <literal>Ndb</literal> objects.
+            Delete <literal role="ndbapi">Ndb</literal> objects.
           </para>
         </listitem>
 
         <listitem>
           <para>
             Terminate the connection to the cluster (terminate an
-            instance of <literal>Ndb_cluster_connection</literal>).
+            instance of
+            <literal role="ndbapi">Ndb_cluster_connection</literal>).
           </para>
         </listitem>
 

@@ -741,7 +744,7 @@
           <listitem>
             <para>
               Start a transaction (instantiate an
-              <literal>NdbTransaction</literal> object).
+              <literal role="ndbapi">NdbTransaction</literal> object).
             </para>
           </listitem>
 

@@ -749,17 +752,18 @@
             <para>
               Add and define operations associated with the transaction
               using instances of one or more of the
-              <literal>NdbOperation</literal>,
-              <literal>NdbScanOperation</literal>,
-              <literal>NdbIndexOperation</literal>, and
-              <literal>NdbIndexScanOperation</literal> classes.
+              <literal role="ndbapi">NdbOperation</literal>,
+              <literal role="ndbapi">NdbScanOperation</literal>,
+              <literal role="ndbapi">NdbIndexOperation</literal>, and
+              <literal role="ndbapi">NdbIndexScanOperation</literal>
+              classes.
             </para>
           </listitem>
 
           <listitem>
             <para>
               Execute the transaction (call
-              <literal>NdbTransaction::execute()</literal>).
+              <literal role="ndbapi">NdbTransaction::execute()</literal>).
             </para>
           </listitem>
 

@@ -839,10 +843,11 @@
           <listitem>
             <para>
               Begin (create) the transaction, which is referenced by an
-              <literal>NdbTransaction</literal> object typically created
-              using <literal>Ndb::startTransaction()</literal>. At this
-              point, the transaction is merely being defined; it is not
-              yet sent to the NDB kernel.
+              <literal role="ndbapi">NdbTransaction</literal> object
+              typically created using
+              <literal role="ndbapi">Ndb::startTransaction()</literal>.
+              At this point, the transaction is merely being defined; it
+              is not yet sent to the NDB kernel.
             </para>
           </listitem>
 

@@ -855,7 +860,8 @@
 
               Define operations and add them to the transaction, using
               one or more of the following, along with the appropriate
-              methods of the respective<literal>NdbOperation</literal>
+              methods of the
+              respective<literal role="ndbapi">NdbOperation</literal>
               class (or possibly one or more of its subclasses):
             </para>
 

@@ -863,25 +869,25 @@
 
               <listitem>
                 <para>
-                  <literal>NdbTransaction::getNdbOperation()</literal>
+                  <literal role="ndbapi">NdbTransaction::getNdbOperation()</literal>
                 </para>
               </listitem>
 
               <listitem>
                 <para>
-                  <literal>NdbTransaction::getNdbScanOperation()</literal>
+                  <literal role="ndbapi">NdbTransaction::getNdbScanOperation()</literal>
                 </para>
               </listitem>
 
               <listitem>
                 <para>
-                  <literal>NdbTransaction::getNdbIndexOperation()</literal>
+                  <literal role="ndbapi">NdbTransaction::getNdbIndexOperation()</literal>
                 </para>
               </listitem>
 
               <listitem>
                 <para>
-                  <literal>NdbTransaction::getNdbIndexScanOperation()</literal>
+                  <literal role="ndbapi">NdbTransaction::getNdbIndexScanOperation()</literal>
                 </para>
               </listitem>
 

@@ -896,14 +902,15 @@
           <listitem>
             <para>
               Execute the transaction, using the
-              <literal>NdbTransaction::execute()</literal> method.
+              <literal role="ndbapi">NdbTransaction::execute()</literal>
+              method.
             </para>
           </listitem>
 
           <listitem>
             <para>
               Close the transaction by calling
-              <literal>Ndb::closeTransaction()</literal>.
+              <literal role="ndbapi">Ndb::closeTransaction()</literal>.
             </para>
           </listitem>
 

@@ -916,8 +923,9 @@
 
         <para>
           To execute several synchronous transactions in parallel, you
-          can either use multiple <literal>Ndb</literal> objects in
-          several threads, or start multiple application programs.
+          can either use multiple <literal role="ndbapi">Ndb</literal>
+          objects in several threads, or start multiple application
+          programs.
         </para>
 
       </section>

@@ -937,13 +945,14 @@
         </indexterm>
 
         <para>
-          An <literal>NdbTransaction</literal> consists of a list of
-          operations, each of which is represented by an instance of
-          <literal>NdbOperation</literal>,
-          <literal>NdbScanOperation</literal>,
-          <literal>NdbIndexOperation</literal>, or
-          <literal>NdbIndexScanOperation</literal> (that is, of
-          <literal>NdbOperation</literal> or one of its child classes).
+          An <literal role="ndbapi">NdbTransaction</literal> consists of
+          a list of operations, each of which is represented by an
+          instance of <literal role="ndbapi">NdbOperation</literal>,
+          <literal role="ndbapi">NdbScanOperation</literal>,
+          <literal role="ndbapi">NdbIndexOperation</literal>, or
+          <literal role="ndbapi">NdbIndexScanOperation</literal> (that
+          is, of <literal role="ndbapi">NdbOperation</literal> or one of
+          its child classes).
         </para>
 
         <para>

@@ -974,21 +983,21 @@
             <listitem>
               <para>
                 Specify the standard operation type using
-                <literal>NdbOperation::readTuple()</literal>.
+                <literal role="ndbapi">NdbOperation::readTuple()</literal>.
               </para>
             </listitem>
 
             <listitem>
               <para>
                 Specify search conditions using
-                <literal>NdbOperation::equal()</literal>.
+                <literal role="ndbapi">NdbOperation::equal()</literal>.
               </para>
             </listitem>
 
             <listitem>
               <para>
                 Specify attribute actions using
-                <literal>NdbOperation::getValue()</literal>.
+                <literal role="ndbapi">NdbOperation::getValue()</literal>.
               </para>
             </listitem>
 

@@ -1005,7 +1014,8 @@
           </indexterm>
 
           <para>
-            This first example uses an <literal>NdbOperation</literal>:
+            This first example uses an
+            <literal role="ndbapi">NdbOperation</literal>:
           </para>
 
 <programlisting>

@@ -1037,7 +1047,7 @@
 
           <para>
             The second example uses an
-            <literal>NdbIndexOperation</literal>:
+            <literal role="ndbapi">NdbIndexOperation</literal>:
           </para>
 
 <programlisting>

@@ -1084,14 +1094,14 @@
 
                 <listitem>
                   <para>
-                    <literal>NdbOperation::insertTuple()</literal>:
+                    <literal role="ndbapi">NdbOperation::insertTuple()</literal>:
                     Inserts a nonexisting tuple.
                   </para>
                 </listitem>
 
                 <listitem>
                   <para>
-                    <literal>NdbOperation::writeTuple()</literal>:
+                    <literal role="ndbapi">NdbOperation::writeTuple()</literal>:
                     Updates a tuple if one exists, otherwise inserts a
                     new tuple.
                   </para>

@@ -1099,22 +1109,23 @@
 
                 <listitem>
                   <para>
-                    <literal>NdbOperation::updateTuple()</literal>:
+                    <literal role="ndbapi">NdbOperation::updateTuple()</literal>:
                     Updates an existing tuple.
                   </para>
                 </listitem>
 
                 <listitem>
                   <para>
-                    <literal>NdbOperation::deleteTuple()</literal>:
+                    <literal role="ndbapi">NdbOperation::deleteTuple()</literal>:
                     Deletes an existing tuple.
                   </para>
                 </listitem>
 
                 <listitem>
                   <para>
-                    <literal>NdbOperation::readTuple()</literal>: Reads
-                    an existing tuple using the specified lock mode.
+                    <literal role="ndbapi">NdbOperation::readTuple()</literal>:
+                    Reads an existing tuple using the specified lock
+                    mode.
                   </para>
                 </listitem>
 

@@ -1122,18 +1133,18 @@
 
               <para>
                 All of these operations operate on the unique tuple key.
-                When <literal>NdbIndexOperation</literal> is used, then
-                each of these operations operates on a defined unique
-                hash index.
+                When <literal role="ndbapi">NdbIndexOperation</literal>
+                is used, then each of these operations operates on a
+                defined unique hash index.
               </para>
 
               <note>
                 <para>
                   If you want to define multiple operations within the
                   same transaction, then you need to call
-                  <literal>NdbTransaction::getNdbOperation()</literal>
+                  <literal role="ndbapi">NdbTransaction::getNdbOperation()</literal>
                   or
-                  <literal>NdbTransaction::getNdbIndexOperation()</literal>
+                  <literal role="ndbapi">NdbTransaction::getNdbIndexOperation()</literal>
                   for each operation.
                 </para>
               </note>

@@ -1147,7 +1158,7 @@
                 <para>
                   The search condition is used to select tuples. Search
                   conditions are set using
-                  <literal>NdbOperation::equal()</literal>.
+                  <literal role="ndbapi">NdbOperation::equal()</literal>.
                 </para>
 
               </formalpara>

@@ -1193,10 +1204,11 @@
               </itemizedlist>
 
               <para>
-                <literal>NdbOperation::getValue()</literal> returns an
-                <literal>NdbRecAttr</literal> object containing the
-                value as read. To obtain the actual value, one of two
-                methods can be used; the application can either
+                <literal role="ndbapi">NdbOperation::getValue()</literal>
+                returns an <literal role="ndbapi">NdbRecAttr</literal>
+                object containing the value as read. To obtain the
+                actual value, one of two methods can be used; the
+                application can either
               </para>
 
               <itemizedlist>

@@ -1205,30 +1217,33 @@
                   <para>
                     Use its own memory (passed through a pointer
                     <replaceable>aValue</replaceable>) to
-                    <literal>NdbOperation::getValue()</literal>, or
+                    <literal role="ndbapi">NdbOperation::getValue()</literal>,
+                    or
                   </para>
                 </listitem>
 
                 <listitem>
                   <para>
                     receive the attribute value in an
-                    <literal>NdbRecAttr</literal> object allocated by
-                    the NDB API.
+                    <literal role="ndbapi">NdbRecAttr</literal> object
+                    allocated by the NDB API.
                   </para>
                 </listitem>
 
               </itemizedlist>
 
               <para>
-                The <literal>NdbRecAttr</literal> object is released
-                when <literal>Ndb::closeTransaction()</literal> is
-                called. For this reason, the application cannot
+                The <literal role="ndbapi">NdbRecAttr</literal> object
+                is released when
+                <literal role="ndbapi">Ndb::closeTransaction()</literal>
+                is called. For this reason, the application cannot
                 reference this object following any subsequent call to
-                <literal>Ndb::closeTransaction()</literal>. Attempting
-                to read data from an <literal>NdbRecAttr</literal>
-                object before calling
-                <literal>NdbTransaction::execute()</literal> yields an
-                undefined result.
+                <literal role="ndbapi">Ndb::closeTransaction()</literal>.
+                Attempting to read data from an
+                <literal role="ndbapi">NdbRecAttr</literal> object
+                before calling
+                <literal role="ndbapi">NdbTransaction::execute()</literal>
+                yields an undefined result.
               </para>
             </listitem>
 

@@ -1253,8 +1268,9 @@
             Scans are roughly the equivalent of SQL cursors, providing a
             means to perform high-speed row processing. A scan can be
             performed on either a table (using an
-            <literal>NdbScanOperation</literal>) or an ordered index (by
-            means of an <literal>NdbIndexScanOperation</literal>).
+            <literal role="ndbapi">NdbScanOperation</literal>) or an
+            ordered index (by means of an
+            <literal role="ndbapi">NdbIndexScanOperation</literal>).
           </para>
 
           <indexterm>

@@ -1297,8 +1313,9 @@
 
           <para>
             After the operation is created using
-            <literal>NdbTransaction::getNdbScanOperation()</literal> or
-            <literal>NdbTransaction::getNdbIndexScanOperation()</literal>,
+            <literal role="ndbapi">NdbTransaction::getNdbScanOperation()</literal>
+            or
+            <literal role="ndbapi">NdbTransaction::getNdbIndexScanOperation()</literal>,
             it is carried out as follows:
           </para>
 

@@ -1307,7 +1324,7 @@
             <listitem>
               <para>
                 Define the standard operation type, using
-                <literal>NdbScanOperation::readTuples()</literal>.
+                <literal role="ndbapi">NdbScanOperation::readTuples()</literal>.
               </para>
 
               <note>

@@ -1323,30 +1340,30 @@
             <listitem>
               <para>
                 Specify search conditions, using
-                <literal>NdbScanFilter</literal>,
-                <literal>NdbIndexScanOperation::setBound()</literal>, or
-                both.
+                <literal role="ndbapi">NdbScanFilter</literal>,
+                <literal role="ndbapi">NdbIndexScanOperation::setBound()</literal>,
+                or both.
               </para>
             </listitem>
 
             <listitem>
               <para>
                 Specify attribute actions using
-                <literal>NdbOperation::getValue()</literal>.
+                <literal role="ndbapi">NdbOperation::getValue()</literal>.
               </para>
             </listitem>
 
             <listitem>
               <para>
                 Execute the transaction using
-                <literal>NdbTransaction::execute()</literal>.
+                <literal role="ndbapi">NdbTransaction::execute()</literal>.
               </para>
             </listitem>
 
             <listitem>
               <para>
                 Traverse the result set by means of successive calls to
-                <literal>NdbScanOperation::nextResult()</literal>.
+                <literal role="ndbapi">NdbScanOperation::nextResult()</literal>.
               </para>
             </listitem>
 

@@ -1360,7 +1377,7 @@
 
           <para>
             This first example performs a table scan using an
-            <literal>NdbScanOperation</literal>:
+            <literal role="ndbapi">NdbScanOperation</literal>:
           </para>
 
 <programlisting>

@@ -1386,8 +1403,8 @@
 
           <para>
             The second example uses an
-            <literal>NdbIndexScanOperation</literal> to perform an index
-            scan:
+            <literal role="ndbapi">NdbIndexScanOperation</literal> to
+            perform an index scan:
           </para>
 
 <programlisting>

@@ -1424,8 +1441,9 @@
                 <para>
                   It is important to remember that only a single
                   operation is supported for each scan operation
-                  (<literal>NdbScanOperation::readTuples()</literal> or
-                  <literal>NdbIndexScanOperation::readTuples()</literal>).
+                  (<literal role="ndbapi">NdbScanOperation::readTuples()</literal>
+                  or
+                  <literal role="ndbapi">NdbIndexScanOperation::readTuples()</literal>).
                 </para>
 
               </formalpara>

@@ -1434,9 +1452,9 @@
                 <para>
                   If you want to define multiple scan operations within
                   the same transaction, then you need to call
-                  <literal>NdbTransaction::getNdbScanOperation()</literal>
+                  <literal role="ndbapi">NdbTransaction::getNdbScanOperation()</literal>
                   or
-                  <literal>NdbTransaction::getNdbIndexScanOperation()</literal>
+                  <literal role="ndbapi">NdbTransaction::getNdbIndexScanOperation()</literal>
                   separately for <emphasis>each</emphasis> operation.
                 </para>
               </note>

@@ -1451,13 +1469,15 @@
                   The search condition is used to select tuples. If no
                   search condition is specified, the scan will return
                   all rows in the table. The search condition can be an
-                  <literal>NdbScanFilter</literal> (which can be used on
-                  both <literal>NdbScanOperation</literal> and
-                  <literal>NdbIndexScanOperation</literal>) or bounds
-                  (which can be used only on index scans - see
-                  <literal>NdbIndexScanOperation::setBound()</literal>).
+                  <literal role="ndbapi">NdbScanFilter</literal> (which
+                  can be used on both
+                  <literal role="ndbapi">NdbScanOperation</literal> and
+                  <literal role="ndbapi">NdbIndexScanOperation</literal>)
+                  or bounds (which can be used only on index scans - see
+                  <literal role="ndbapi">NdbIndexScanOperation::setBound()</literal>).
                   An index scan can use both
-                  <literal>NdbScanFilter</literal> and bounds.
+                  <literal role="ndbapi">NdbScanFilter</literal> and
+                  bounds.
                 </para>
 
               </formalpara>

@@ -1486,8 +1506,9 @@
                   document (see
                   <xref linkend="overview-synchronous-transactions"/>),
                   the value read is returned by the
-                  <literal>NdbOperation::getValue()</literal> method as
-                  an <literal>NdbRecAttr</literal> object.
+                  <literal role="ndbapi">NdbOperation::getValue()</literal>
+                  method as an
+                  <literal role="ndbapi">NdbRecAttr</literal> object.
                 </para>
 
               </formalpara>

@@ -1524,21 +1545,21 @@
               <para>
                 (<emphasis>When iterating through the result
                 set</emphasis>:) For each row, optionally calling either
-                <literal>NdbScanOperation::updateCurrentTuple()</literal>
+                <literal role="ndbapi">NdbScanOperation::updateCurrentTuple()</literal>
                 or
-                <literal>NdbScanOperation::deleteCurrentTuple()</literal>.
+                <literal role="ndbapi">NdbScanOperation::deleteCurrentTuple()</literal>.
               </para>
             </listitem>
 
             <listitem>
               <para>
                 (<emphasis>If performing
-                <literal>NdbScanOperation::updateCurrentTuple()</literal></emphasis>:)
+                <literal role="ndbapi">NdbScanOperation::updateCurrentTuple()</literal></emphasis>:)
                 Setting new values for records simply by using
-                <literal>NdbOperation::setValue()</literal>.
-                <literal>NdbOperation::equal()</literal> should not be
-                called in such cases, as the primary key is retrieved
-                from the scan.
+                <literal role="ndbapi">NdbOperation::setValue()</literal>.
+                <literal role="ndbapi">NdbOperation::equal()</literal>
+                should not be called in such cases, as the primary key
+                is retrieved from the scan.
               </para>
             </listitem>
 

@@ -1547,11 +1568,12 @@
           <important>
             <para>
               The update or delete is not actually performed until the
-              next call to <literal>NdbTransaction::execute()</literal>
+              next call to
+              <literal role="ndbapi">NdbTransaction::execute()</literal>
               is made, just as with single row operations.
-              <literal>NdbTransaction::execute()</literal> also must be
-              called before any locks are released; for more
-              information, see
+              <literal role="ndbapi">NdbTransaction::execute()</literal>
+              also must be called before any locks are released; for
+              more information, see
               <xref linkend="overview-scans-lock-handling"/>.
             </para>
           </important>

@@ -1563,10 +1585,10 @@
             <para>
               When performing an index scan, it is possible to scan only
               a subset of a table using
-              <literal>NdbIndexScanOperation::setBound()</literal>. In
-              addition, result sets can be sorted in either ascending or
-              descending order, using
-              <literal>NdbIndexScanOperation::readTuples()</literal>.
+              <literal role="ndbapi">NdbIndexScanOperation::setBound()</literal>.
+              In addition, result sets can be sorted in either ascending
+              or descending order, using
+              <literal role="ndbapi">NdbIndexScanOperation::readTuples()</literal>.
               Note that rows are returned unordered by default unless
               <replaceable>sorted</replaceable> is set to
               <literal>true</literal>.

@@ -1576,11 +1598,12 @@
 
           <para>
             It is also important to note that, when using
-            <literal>NdbIndexScanOperation::BoundEQ()</literal> on a
-            partition key, only fragments containing rows will actually
-            be scanned. Finally, when performing a sorted scan, any
-            value passed as the
-            <literal>NdbIndexScanOperation::readTuples()</literal>
+            <literal>NdbIndexScanOperation::BoundEQ</literal> (see
+            <xref linkend="ndb-ndbindexscanoperation-boundtype"/>) with
+            a partition key, only fragments containing rows will
+            actually be scanned. Finally, when performing a sorted scan,
+            any value passed as the
+            <literal role="ndbapi">NdbIndexScanOperation::readTuples()</literal>
             method's <replaceable>parallel</replaceable> argument will
             be ignored and maximum parallelism will be used instead. In
             other words, all fragments which it is possible to scan are

@@ -1609,18 +1632,19 @@
             only a predetermined number of rows per fragment at a time.
             The number of rows locked per fragment is controlled by the
             batch parameter passed to
-            <literal>NdbScanOperation::readTuples()</literal>.
+            <literal role="ndbapi">NdbScanOperation::readTuples()</literal>.
           </para>
 
           <para>
             In order to enable the application to handle how locks are
-            released, <literal>NdbScanOperation::nextResult()</literal>
+            released,
+            <literal role="ndbapi">NdbScanOperation::nextResult()</literal>
             has a Boolean parameter
             <replaceable>fetchAllowed</replaceable>. If
-            <literal>NdbScanOperation::nextResult()</literal> is called
-            with <replaceable>fetchAllowed</replaceable> equal to
-            <literal>false</literal>, then no locks may be released as
-            result of the function call. Otherwise the locks for the
+            <literal role="ndbapi">NdbScanOperation::nextResult()</literal>
+            is called with <replaceable>fetchAllowed</replaceable> equal
+            to <literal>false</literal>, then no locks may be released
+            as result of the function call. Otherwise the locks for the
             current batch may be released.
           </para>
 

@@ -1669,17 +1693,17 @@
             transaction are being defined, or when the transaction is
             actually being executed. Catching and handling either sort
             of error requires testing the value returned by
-            <literal>NdbTransaction::execute()</literal>, and then, if
-            an error is indicated (that is, if this value is equal to
-            <literal>-1</literal>), using the following two methods in
-            order to identify the error's type and location:
+            <literal role="ndbapi">NdbTransaction::execute()</literal>,
+            and then, if an error is indicated (that is, if this value
+            is equal to <literal>-1</literal>), using the following two
+            methods in order to identify the error's type and location:
           </para>
 
           <itemizedlist>
 
             <listitem>
               <para>
-                <literal>NdbTransaction::getNdbErrorOperation()</literal>
+                <literal role="ndbapi">NdbTransaction::getNdbErrorOperation()</literal>
                 returns a reference to the operation causing the most
                 recent error.
               </para>

@@ -1687,7 +1711,7 @@
 
             <listitem>
               <para>
-                <literal>NdbTransaction::getNdbErrorLine()</literal>
+                <literal role="ndbapi">NdbTransaction::getNdbErrorLine()</literal>
                 yields the method number of the erroneous method in the
                 operation, starting with <literal>1</literal>.
               </para>

@@ -1722,25 +1746,27 @@
           <para>
             Here, <literal>errorLine</literal> is <literal>3</literal>,
             as the error occurred in the third method called on the
-            <literal>NdbOperation</literal> object (in this case,
-            <literal>theOperation</literal>). If the result of
-            <literal>NdbTransaction::getNdbErrorLine()</literal> is
-            <literal>0</literal>, then the error occurred when the
+            <literal role="ndbapi">NdbOperation</literal> object (in
+            this case, <literal>theOperation</literal>). If the result
+            of
+            <literal role="ndbapi">NdbTransaction::getNdbErrorLine()</literal>
+            is <literal>0</literal>, then the error occurred when the
             operations were executed. In this example,
             <literal>errorOperation</literal> is a pointer to the object
             <literal>theOperation</literal>. The
-            <literal>NdbTransaction::getNdbError()</literal> method
-            returns an <literal>NdbError</literal> object providing
-            information about the error.
+            <literal role="ndbapi">NdbTransaction::getNdbError()</literal>
+            method returns an <literal role="ndbapi">NdbError</literal>
+            object providing information about the error.
           </para>
 
           <note>
             <para>
               Transactions are <emphasis>not</emphasis> automatically
               closed when an error occurs. You must call
-              <literal>Ndb::closeTransaction()</literal> or
-              <literal>NdbTransaction::close()</literal> to close the
-              transaction.
+              <literal role="ndbapi">Ndb::closeTransaction()</literal>
+              or
+              <literal role="ndbapi">NdbTransaction::close()</literal>
+              to close the transaction.
             </para>
 
             <para>

@@ -1759,9 +1785,10 @@
             <listitem>
               <para>
                 Roll back the transaction by calling
-                <literal>NdbTransaction::execute()</literal> with a
-                special <literal>ExecType</literal> value for the
-                <replaceable>type</replaceable> parameter.
+                <literal role="ndbapi">NdbTransaction::execute()</literal>
+                with a special
+                <literal role="ndbapi:NdbTransaction">ExecType</literal>
+                value for the <replaceable>type</replaceable> parameter.
               </para>
 
               <para>

@@ -1774,7 +1801,7 @@
             <listitem>
               <para>
                 Close the transaction by calling
-                <literal>NdbTransaction::closeTransaction()</literal>.
+                <literal role="ndbapi">NdbTransaction::close()</literal>.
               </para>
             </listitem>
 

@@ -1791,8 +1818,9 @@
             Several errors can occur when a transaction contains
             multiple operations which are simultaneously executed. In
             this case the application must go through all operations and
-            query each of their <literal>NdbError</literal> objects to
-            find out what really happened.
+            query each of their
+            <literal role="ndbapi">NdbError</literal> objects to find
+            out what really happened.
           </para>
 
           <important>

@@ -1800,8 +1828,8 @@
               Errors can occur even when a commit is reported as
               successful. In order to handle such situations, the NDB
               API provides an additional
-              <literal>NdbTransaction::commitStatus()</literal> method
-              to check the transaction's commit status.
+              <literal role="ndbapi">NdbTransaction::commitStatus()</literal>
+              method to check the transaction's commit status.
             </para>
 
             <para>

@@ -2147,12 +2175,12 @@
 
       <para>
         When transactions are sent using
-        <literal>NdbTransaction::execute()</literal>, they are not
-        immediately transferred to the NDB Kernel. Instead, transactions
-        are kept in a special send list (buffer) in the
-        <literal>Ndb</literal> object to which they belong. The adaptive
-        send algorithm decides when transactions should actually be
-        transferred to the NDB kernel.
+        <literal role="ndbapi">NdbTransaction::execute()</literal>, they
+        are not immediately transferred to the NDB Kernel. Instead,
+        transactions are kept in a special send list (buffer) in the
+        <literal role="ndbapi">Ndb</literal> object to which they
+        belong. The adaptive send algorithm decides when transactions
+        should actually be transferred to the NDB kernel.
       </para>
 
       <indexterm>

@@ -2163,18 +2191,19 @@
         The NDB API is designed as a multi-threaded interface, and so it
         is often desirable to transfer database operations from more
         than one thread at a time. The NDB API keeps track of which
-        <literal>Ndb</literal> objects are active in transferring
-        information to the NDB kernel and the expected number of threads
-        to interact with the NDB kernel. Note that a given instance of
-        <literal>Ndb</literal> should be used in at most one thread;
-        different threads should <emphasis>not</emphasis> share the same
-        <literal>Ndb</literal> object.
+        <literal role="ndbapi">Ndb</literal> objects are active in
+        transferring information to the NDB kernel and the expected
+        number of threads to interact with the NDB kernel. Note that a
+        given instance of <literal role="ndbapi">Ndb</literal> should be
+        used in at most one thread; different threads should
+        <emphasis>not</emphasis> share the same
+        <literal role="ndbapi">Ndb</literal> object.
       </para>
 
       <para>
         There are four conditions leading to the transfer of database
-        operations from <literal>Ndb</literal> object buffers to the NDB
-        kernel:
+        operations from <literal role="ndbapi">Ndb</literal> object
+        buffers to the NDB kernel:
       </para>
 
       <orderedlist>

@@ -2186,9 +2215,9 @@
             implementation-dependent and may change between MySQL
             Cluster releases. When TCP/IP is the transporter, the buffer
             size is usually around 64 KB. Since each
-            <literal>Ndb</literal> object provides a single buffer per
-            data node, the notion of a <quote>full</quote> buffer is
-            local to each data node.
+            <literal role="ndbapi">Ndb</literal> object provides a
+            single buffer per data node, the notion of a
+            <quote>full</quote> buffer is local to each data node.
           </para>
         </listitem>
 

@@ -2216,7 +2245,8 @@
         <listitem>
           <para>
             For methods that are affected by the adaptive send algorithm
-            (such as <literal>NdbTransaction::execute()</literal>),
+            (such as
+            <literal role="ndbapi">NdbTransaction::execute()</literal>),
             there is a <replaceable>force</replaceable> parameter that
             overrides its default behavior in this regard and forces
             immediate transmission to all nodes. See the individual NDB


Thread
svn commit - mysqldoc@docsrva: r24018 - trunk/ndbapijon.stephens25 Nov