Author: jstephens
Date: 2006-07-03 10:48:10 +0200 (Mon, 03 Jul 2006)
New Revision: 2603
Log:
Cleanup: Adding/updating cross-references.
Modified:
trunk/ndbapi/mgm-api.xml
trunk/ndbapi/ndb-classes.xml
trunk/ndbapi/overview.xml
Modified: trunk/ndbapi/mgm-api.xml
===================================================================
--- trunk/ndbapi/mgm-api.xml 2006-07-03 08:23:35 UTC (rev 2602)
+++ trunk/ndbapi/mgm-api.xml 2006-07-03 08:48:10 UTC (rev 2603)
@@ -1843,7 +1843,7 @@
format is shown here:
<programlisting>
-<replaceable>connectstring</replaceable> := [<remark>nodeid-specification</remark>,]<replaceable>host-specification</replaceable>[,<replaceable>host-specification</replaceable>]
+<replaceable>connectstring</replaceable> := [<replaceable>nodeid-specification</replaceable>,]<replaceable>host-specification</replaceable>[,<replaceable>host-specification</replaceable>]
</programlisting>
(It is possible to establish connections with multiple
Modified: trunk/ndbapi/ndb-classes.xml
===================================================================
--- trunk/ndbapi/ndb-classes.xml 2006-07-03 08:23:35 UTC (rev 2602)
+++ trunk/ndbapi/ndb-classes.xml 2006-07-03 08:48:10 UTC (rev 2603)
@@ -767,12 +767,7 @@
<para>
See <xref linkend="class-ndb-closetransaction"/>, and
- <xref linkend="class-ndbtransaction"/>.
-
- <remark role="todo">
- [js] Update the previous link to point directly to the
- method once the section for it has been created.
- </remark>
+ <xref linkend="class-ndbtransaction-close"/>.
</para>
</important>
@@ -877,15 +872,10 @@
This is one of two NDB API methods provided for closing a
transaction (the other being
<literal>NdbTransaction::close()</literal> — see
- <xref linkend="class-ndbtransaction"/>). You must call one
- of these two methods to close the transaction once it has
- been completed, whether or not the transaction succeeded.
-
- <remark
- role="todo">
- [js] Update the previous link to point directly to the
- method once the section for it has been created.
- </remark>
+ <xref linkend="class-ndbtransaction-close"/>). You must call
+ one of these two methods to close the transaction once it
+ has been completed, whether or not the transaction
+ succeeded.
</para>
</formalpara>
@@ -1744,14 +1734,9 @@
<para>
This method takes one parameter;
-
- <remark>
- timeout
- </remark>
-
- specifies the number of second to wait until the first
- <quote>live</quote> data node is detected. This parameter
- has no default value.
+ <replaceable>timeout</replaceable> specifies the number of
+ second to wait until the first <quote>live</quote> data node
+ is detected. This parameter has no default value.
</para>
</formalpara>
@@ -2682,9 +2667,26 @@
<title>Parameters</title>
<para>
- <remark role="todo">
- [js] Not really explained in existing docs/sources.
- </remark>
+ This method takes two parameters:
+
+ <itemizedlist>
+
+ <listitem>
+ <para>
+ The <replaceable>data</replaceable> that is to be
+ inserted or used to overwrite the blob value.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ The number of <replaceable>bytes</replaceable> —
+ that is, the length — of the
+ <replaceable>data</replaceable>.
+ </para>
+ </listitem>
+
+ </itemizedlist>
</para>
</formalpara>
@@ -13102,7 +13104,7 @@
You must invoke
<literal>Dictionary::createEvent()</literal> before any
errors will be detected. See
- <xref linkend="class-dictionary"/>.
+ <xref linkend="class-dictionary-createevent"/>.
</para>
</important>
@@ -13225,7 +13227,7 @@
As with <literal>addEventColumn()</literal>, you must
invoke <literal>Dictionary::createEvent()</literal>
before any errors will be detected. See
- <xref linkend="class-dictionary"/>.
+ <xref linkend="class-dictionary-createevent"/>.
</para>
</important>
@@ -22630,8 +22632,7 @@
<mediaobject>
<imageobject>
- <imagedata
- fileref="images/NdbDictionary-AutoGrowSpecification-struct.png" format="PNG"/>
+ <imagedata fileref="images/NdbDictionary-AutoGrowSpecification-struct.png" format="PNG"/>
</imageobject>
<textobject>
<phrase lang="en">Members of the data structure
@@ -24759,10 +24760,6 @@
<literal>NdbTransaction::execute()</literal>.
</para>
- <remark role="todo">
- [js] Add link when NdbRecAttr section complete
- </remark>
-
<para>
If a specific attribute has not changed, the corresponding
<literal>NdbRecAttr</literal> will be in the state
@@ -24770,6 +24767,11 @@
<literal>NdbRecAttr::isNULL()</literal> which in such cases
returns <literal>-1</literal>.
</para>
+
+ <para>
+ See <xref linkend="class-ndbtransaction-execute"/>, and
+ <xref linkend="class-ndbrecattr-isnull"/>.
+ </para>
</important>
<formalpara>
Modified: trunk/ndbapi/overview.xml
===================================================================
--- trunk/ndbapi/overview.xml 2006-07-03 08:23:35 UTC (rev 2602)
+++ trunk/ndbapi/overview.xml 2006-07-03 08:48:10 UTC (rev 2603)
@@ -479,10 +479,6 @@
fundamental classes:
</para>
- <remark role="todo">
- [js] Provide links to detailed class listings.
- </remark>
-
<itemizedlist>
<listitem>
@@ -490,6 +486,10 @@
<literal>Ndb_cluster_connection</literal> represents a
connection to a cluster.
</para>
+
+ <para>
+ See <xref linkend="class-ndb-cluster-connection"/>.
+ </para>
</listitem>
<listitem>
@@ -497,12 +497,20 @@
<literal>Ndb</literal> is the main class, and represents a
connection to a database.
</para>
+
+ <para>
+ See <xref linkend="class-ndb"/>.
+ </para>
</listitem>
<listitem>
<para>
<literal>NdbTransaction</literal> represents a transaction.
</para>
+
+ <para>
+ See <xref linkend="class-ndbtransaction"/>.
+ </para>
</listitem>
<listitem>
@@ -510,6 +518,10 @@
<literal>NdbOperation</literal> represents an operation
using a primary key.
</para>
+
+ <para>
+ See <xref linkend="class-ndboperation"/>.
+ </para>
</listitem>
<listitem>
@@ -517,6 +529,10 @@
<literal>NdbScanOperation</literal> represents an operation
performing a full table scan.
</para>
+
+ <para>
+ See <xref linkend="class-ndbscanoperation"/>.
+ </para>
</listitem>
<listitem>
@@ -524,6 +540,10 @@
<literal>NdbIndexOperation</literal> represents an operation
using a unique hash index.
</para>
+
+ <para>
+ See <xref linkend="class-ndbindexoperation"/>.
+ </para>
</listitem>
<listitem>
@@ -531,19 +551,31 @@
<literal>NdbIndexScanOperation</literal> represents an
operation performing a scan using an ordered index.
</para>
+
+ <para>
+ See <xref linkend="class-ndbindexscanoperation"/>.
+ </para>
</listitem>
<listitem>
<para>
<literal>NdbRecAttr</literal> represents an attribute value.
</para>
+
+ <para>
+ See <xref linkend="class-ndbrecattr"/>.
+ </para>
</listitem>
<listitem>
<para>
- <literal>NdbDictionary</literal> represents meta-information
+ <literal>NdbDictionary</literal> provides meta-information
about tables and attributes.
</para>
+
+ <para>
+ See <xref linkend="class-ndbdictionary"/>.
+ </para>
</listitem>
</itemizedlist>
@@ -1810,10 +1842,10 @@
can be reconfigured at any time, in which case the NDB API
chooses a transaction coordinator without using the hint. For
more information, see
- <literal>NdbDictionary::Column::getPartitionKey()</literal>
- and <literal>Ndb::startTransaction()</literal>. The
- application programmer can specify the partition key from SQL
- by using the construct,
+ <xref linkend="class-column-getpartitionkey"/>, and
+ <xref linkend="class-ndb-starttransaction"/>. The application
+ programmer can specify the partition key from SQL by using
+ this construct:
</para>
<programlisting>
| Thread |
|---|
| • svn commit - mysqldoc@docsrva: r2603 - trunk/ndbapi | jon | 3 Jul |
