Author: jstephens
Date: 2010-11-16 18:49:24 +0100 (Tue, 16 Nov 2010)
New Revision: 23774
Log:
Add NDB API auto-link markup (WL#4183)
Modified:
trunk/ndbapi/ndb-getting-started.xml
trunk/ndbapi/ndb-getvaluespec.xml
trunk/ndbapi/ndb-hierarchy.xml
trunk/ndbapi/ndb-index.xml
Modified: trunk/ndbapi/ndb-getting-started.xml
===================================================================
--- trunk/ndbapi/ndb-getting-started.xml 2010-11-16 16:02:44 UTC (rev 23773)
+++ trunk/ndbapi/ndb-getting-started.xml 2010-11-16 17:49:24 UTC (rev 23774)
Changed blocks: 2, Lines Added: 16, Lines Deleted: 14; 2704 bytes
@@ -452,18 +452,18 @@
<para>
To establish a connection to the server, it is necessary to
- create an instance of <literal>Ndb_cluster_connection</literal>,
- whose constructor takes as its argument a cluster connectstring;
- if no connectstring is given, <literal>localhost</literal> is
- assumed.
+ create an instance of
+ <literal role="ndbapi">Ndb_cluster_connection</literal>, whose
+ constructor takes as its argument a cluster connectstring; if no
+ connectstring is given, <literal>localhost</literal> is assumed.
</para>
<para>
The cluster connection is not actually initiated until the
- <literal>Ndb_cluster_connection::connect()</literal> method is
- called. When invoked without any arguments, the connection
- attempt is retried each 1 second indefinitely until successful,
- and no reporting is done. See
+ <literal role="ndbapi">Ndb_cluster_connection::connect()</literal>
+ method is called. When invoked without any arguments, the
+ connection attempt is retried each 1 second indefinitely until
+ successful, and no reporting is done. See
<xref linkend="ndb-ndb-cluster-connection"/>, for details.
</para>
@@ -582,13 +582,15 @@
<para>
Databases and schemas are not represented by objects as such in
the NDB API. Instead, they are modelled as attributes of
- <literal>Table</literal> and <literal>Index</literal> objects.
- The value of the <literal>database</literal> attribute of one of
- these objects is always the same as the name of the MySQL
- database to which the table or index belongs. The value of the
+ <literal role="ndbapi">Table</literal> and
+ <literal role="ndbapi">Index</literal> objects. The value of the
+ <literal>database</literal> attribute of one of these objects is
+ always the same as the name of the MySQL database to which the
+ table or index belongs. The value of the
<literal>schema</literal> attribute of a
- <literal>Table</literal> or <literal>Index</literal> object is
- always '<literal>def</literal>' (for <quote>default</quote>).
+ <literal role="ndbapi">Table</literal> or
+ <literal role="ndbapi">Index</literal> object is always
+ '<literal>def</literal>' (for <quote>default</quote>).
</para>
</formalpara>
Modified: trunk/ndbapi/ndb-getvaluespec.xml
===================================================================
--- trunk/ndbapi/ndb-getvaluespec.xml 2010-11-16 16:02:44 UTC (rev 23773)
+++ trunk/ndbapi/ndb-getvaluespec.xml 2010-11-16 17:49:24 UTC (rev 23774)
Changed blocks: 6, Lines Added: 10, Lines Deleted: 14; 2899 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 obtain as part
- of an
- <link linkend="ndb-ndbrecord"><literal>NdbRecord</literal></link>
- operation.
+ of 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>
@@ -79,12 +76,10 @@
<entry><literal>appStorage</literal></entry>
<entry><literal>void*</literal></entry>
<entry>If this pointer is null, then the received value is stored in memory
- managed by the
- <link linkend="ndb-ndbrecattr"><literal>NdbRecAttr</literal></link>
+ managed by the <literal role="ndbapi">NdbRecAttr</literal>
object. Otherwise, the received value is stored at the
location pointed to (and is still accessable using the
- <link linkend="ndb-ndbrecattr"><literal>NdbRecAttr</literal></link>
- object).
+ <literal role="ndbapi">NdbRecAttr</literal> object).
<important>
<para>
@@ -115,10 +110,11 @@
</row>
<row>
<entry><literal>recAttr</literal></entry>
- <entry><link linkend="ndb-ndbrecattr"><literal>NdbRecAttr</literal></link>*</entry>
+ <entry><literal role="ndbapi">NdbRecAttr</literal>*</entry>
<entry>After the operation is defined, <replaceable>recAttr</replaceable>
- contains a pointer to the <literal>NdbRecAttr</literal>
- object for receiving the data.</entry>
+ contains a pointer to the
+ <literal role="ndbapi">NdbRecAttr</literal> object for
+ receiving the data.</entry>
</row>
</tbody>
</tgroup>
@@ -127,7 +123,7 @@
<important>
<para>
Currently, blob reads cannot be specified using
- <literal>GetValueSpec</literal>.
+ <literal role="ndbapi">GetValueSpec</literal>.
</para>
</important>
Modified: trunk/ndbapi/ndb-hierarchy.xml
===================================================================
--- trunk/ndbapi/ndb-hierarchy.xml 2010-11-16 16:02:44 UTC (rev 23773)
+++ trunk/ndbapi/ndb-hierarchy.xml 2010-11-16 17:49:24 UTC (rev 23774)
Changed blocks: 8, Lines Added: 36, Lines Deleted: 36; 8261 bytes
@@ -16,20 +16,20 @@
<listitem>
<para>
- <link linkend="ndb-ndb"><literal>Ndb</literal></link>
+ <literal role="ndbapi">Ndb</literal>
</para>
<itemizedlist>
<listitem>
<para>
- <link linkend="ndb-key-part-ptr"><literal>Key_part_ptr</literal></link>
+ <literal role="ndbapi">Key_part_ptr</literal>
</para>
</listitem>
<listitem>
<para>
- <link linkend="ndb-partitionspec"><literal>PartitionSpec</literal></link>
+ <literal role="ndbapi">PartitionSpec</literal>
</para>
</listitem>
@@ -38,46 +38,46 @@
<listitem>
<para>
- <link linkend="ndb-ndbblob"><literal>NdbBlob</literal></link>
+ <literal role="ndbapi">NdbBlob</literal>
</para>
</listitem>
<listitem>
<para>
- <link linkend="ndb-ndb-cluster-connection"><literal>Ndb_cluster_connection</literal></link>
+ <literal role="ndbapi">Ndb_cluster_connection</literal>
</para>
</listitem>
<listitem>
<para>
- <link linkend="ndb-ndbdictionary"><literal>NdbDictionary</literal></link>
+ <literal role="ndbapi">NdbDictionary</literal>
</para>
<itemizedlist>
<listitem>
<para>
- <link linkend="ndb-autogrowspecification"><literal>AutoGrowSpecification</literal></link>
+ <literal role="ndbapi">AutoGrowSpecification</literal>
</para>
</listitem>
<listitem>
<para>
- <link linkend="ndb-dictionary"><literal>Dictionary</literal></link>
+ <literal role="ndbapi">Dictionary</literal>
</para>
<itemizedlist>
<listitem>
<para>
- <link linkend="ndb-list"><literal>List</literal></link>
+ <literal role="ndbapi">List</literal>
</para>
<itemizedlist>
<listitem>
<para>
- <link linkend="ndb-element"><literal>Element</literal></link>
+ <literal role="ndbapi">Element</literal>
</para>
</listitem>
@@ -89,56 +89,56 @@
<listitem>
<para>
- <link linkend="ndb-column"><literal>Column</literal></link>
+ <literal role="ndbapi">Column</literal>
</para>
</listitem>
<listitem>
<para>
- <link linkend="ndb-object"><literal>Object</literal></link>
+ <literal role="ndbapi">Object</literal>
</para>
<itemizedlist>
<listitem>
<para>
- <link linkend="ndb-datafile"><literal>Datafile</literal></link>
+ <literal role="ndbapi">Datafile</literal>
</para>
</listitem>
<listitem>
<para>
- <link linkend="ndb-event"><literal>Event</literal></link>
+ <literal role="ndbapi">Event</literal>
</para>
</listitem>
<listitem>
<para>
- <link linkend="ndb-index"><literal>Index</literal></link>
+ <literal role="ndbapi">Index</literal>
</para>
</listitem>
<listitem>
<para>
- <link linkend="ndb-logfilegroup"><literal>LogfileGroup</literal></link>
+ <literal role="ndbapi">LogfileGroup</literal>
</para>
</listitem>
<listitem>
<para>
- <link linkend="ndb-table"><literal>Table</literal></link>
+ <literal role="ndbapi">Table</literal>
</para>
</listitem>
<listitem>
<para>
- <link linkend="ndb-tablespace"><literal>Tablespace</literal></link>
+ <literal role="ndbapi">Tablespace</literal>
</para>
</listitem>
<listitem>
<para>
- <link linkend="ndb-undofile"><literal>Undofile</literal></link>
+ <literal role="ndbapi">Undofile</literal>
</para>
</listitem>
@@ -147,7 +147,7 @@
<listitem>
<para>
- <link linkend="ndb-recordspecification"><literal>RecordSpecification</literal></link>
+ <literal role="ndbapi">RecordSpecification</literal>
</para>
</listitem>
@@ -156,52 +156,52 @@
<listitem>
<para>
- <link linkend="ndb-ndberror"><literal>NdbError</literal></link>
+ <literal role="ndbapi">NdbError</literal>
</para>
</listitem>
<listitem>
<para>
- <link linkend="ndb-ndbeventoperation"><literal>NdbEventOperation</literal></link>
+ <literal role="ndbapi">NdbEventOperation</literal>
</para>
</listitem>
<listitem>
<para>
- <link linkend="ndb-ndbinterpretedcode"><literal>NdbInterpretedCode</literal></link>
+ <literal role="ndbapi">NdbInterpretedCode</literal>
</para>
</listitem>
<listitem>
<para>
- <link linkend="ndb-ndboperation"><literal>NdbOperation</literal></link>
+ <literal role="ndbapi">NdbOperation</literal>
</para>
<itemizedlist>
<listitem>
<para>
- <link linkend="ndb-ndbindexoperation"><literal>NdbIndexOperation</literal></link>
+ <literal role="ndbapi">NdbIndexOperation</literal>
</para>
</listitem>
<listitem>
<para>
- <link linkend="ndb-ndbscanoperation"><literal>NdbScanOperation</literal></link>
+ <literal role="ndbapi">NdbScanOperation</literal>
</para>
<itemizedlist>
<listitem>
<para>
- <link linkend="ndb-ndbindexscanoperation"><literal>NdbIndexScanOperation</literal></link>
+ <literal role="ndbapi">NdbIndexScanOperation</literal>
</para>
<itemizedlist>
<listitem>
<para>
- <link linkend="ndb-indexbound"><literal>IndexBound</literal></link>
+ <literal role="ndbapi">IndexBound</literal>
</para>
</listitem>
@@ -210,7 +210,7 @@
<listitem>
<para>
- <link linkend="ndb-scanoptions"><literal>ScanOptions</literal></link>
+ <literal role="ndbapi">ScanOptions</literal>
</para>
</listitem>
@@ -219,19 +219,19 @@
<listitem>
<para>
- <link linkend="ndb-getvaluespec"><literal>GetValueSpec</literal></link>
+ <literal role="ndbapi">GetValueSpec</literal>
</para>
</listitem>
<listitem>
<para>
- <link linkend="ndb-setvaluespec"><literal>SetValueSpec</literal></link>
+ <literal role="ndbapi">SetValueSpec</literal>
</para>
</listitem>
<listitem>
<para>
- <link linkend="ndb-operationoptions"><literal>OperationOptions</literal></link>
+ <literal role="ndbapi">OperationOptions</literal>
</para>
</listitem>
@@ -240,25 +240,25 @@
<listitem>
<para>
- <link linkend="ndb-ndbrecattr"><literal>NdbRecAttr</literal></link>
+ <literal role="ndbapi">NdbRecAttr</literal>
</para>
</listitem>
<listitem>
<para>
- <link linkend="ndb-ndbrecord"><literal>NdbRecord</literal></link>
+ <literal role="ndbapi">NdbRecord</literal>
</para>
</listitem>
<listitem>
<para>
- <link linkend="ndb-ndbscanfilter"><literal>NdbScanFilter</literal></link>
+ <literal role="ndbapi">NdbScanFilter</literal>
</para>
</listitem>
<listitem>
<para>
- <link linkend="ndb-ndbtransaction"><literal>NdbTransaction</literal></link>
+ <literal role="ndbapi">NdbTransaction</literal>
</para>
</listitem>
Modified: trunk/ndbapi/ndb-index.xml
===================================================================
--- trunk/ndbapi/ndb-index.xml 2010-11-16 16:02:44 UTC (rev 23773)
+++ trunk/ndbapi/ndb-index.xml 2010-11-16 17:49:24 UTC (rev 23774)
Changed blocks: 9, Lines Added: 16, Lines Deleted: 16; 3646 bytes
@@ -47,9 +47,9 @@
<para>
This class represents an index on an <literal>NDB
Cluster</literal> table column. It is a descendant of the
- <literal>NdbDictionary</literal> class, using the
- <literal>Object</literal> class. For information on these, see
- <xref linkend="ndb-ndbdictionary"/>, and
+ <literal role="ndbapi">NdbDictionary</literal> class, using the
+ <literal role="ndbapi">Object</literal> class. For information on
+ these, see <xref linkend="ndb-ndbdictionary"/>, and
<xref linkend="ndb-object"/>.
</para>
@@ -131,7 +131,7 @@
</row>
<row>
<entry><literal><link linkend="ndb-index-addcolumn">addColumn()</link></literal></entry>
- <entry>Adds a <literal>Column</literal> object to the index</entry>
+ <entry>Adds a <literal role="ndbapi">Column</literal> object to the index</entry>
</row>
<row>
<entry><literal><link linkend="ndb-index-addcolumnname">addColumnName()</link></literal></entry>
@@ -210,7 +210,7 @@
<para>
This is an enumerated type which describes the sort of column
index represented by a given instance of
- <literal>Index</literal>.
+ <literal role="ndbapi">Index</literal>.
</para>
</formalpara>
@@ -218,10 +218,8 @@
<caution>
<para>
Do not confuse this enumerated type with
- <literal>Object::Type</literal>, which is discussed in
- <xref linkend="ndb-object-type"/>, or with
- <literal>Table::Type</literal> or
- <literal>Column::Type</literal>.
+ <literal role="ndbapi">Object::Type</literal>, or with
+ <literal role="ndbapi">Column::Type</literal>.
</para>
</caution>
@@ -273,9 +271,10 @@
<para>
This section contain descriptions of all public methods of the
- <literal>Index</literal> class. This class has relatively few
- methods (compared to, say, <literal>Table</literal>), which are
- fairly straightforward to use.
+ <literal role="ndbapi">Index</literal> class. This class has
+ relatively few methods (compared to, say,
+ <literal role="ndbapi">Table</literal>), which are fairly
+ straightforward to use.
</para>
</abstract>
@@ -285,7 +284,7 @@
If you create or change indexes using the <literal>NDB</literal>
API, these modifications cannot be seen by MySQL. The only
exception to this is renaming the index using
- <literal>Index::setName()</literal>.
+ <literal role="ndbapi">Index::setName()</literal>.
</para>
</important>
@@ -299,7 +298,7 @@
<para>
This is used to create an new instance of
- <literal>Index</literal>.
+ <literal role="ndbapi">Index</literal>.
</para>
</formalpara>
@@ -344,7 +343,7 @@
<title>Return value</title>
<para>
- A new instance of <literal>Index</literal>.
+ A new instance of <literal role="ndbapi">Index</literal>.
</para>
</formalpara>
@@ -657,7 +656,8 @@
<para>
The column having position <replaceable>no</replaceable> in
the index, as a pointer to an instance of
- <literal>Column</literal>. See <xref linkend="ndb-column"/>.
+ <literal role="ndbapi">Column</literal>. See
+ <xref linkend="ndb-column"/>.
</para>
</formalpara>
| Thread |
|---|
| • svn commit - mysqldoc@docsrva: r23774 - trunk/ndbapi | jon.stephens | 16 Nov |
