From: jon
Date: March 11 2008 1:10am
Subject: svn commit - mysqldoc@docsrva: r10187 - trunk/ndbapi
List-Archive: http://lists.mysql.com/commits/43710
Message-Id: <200803110110.m2B1AJ2S002441@docsrva.mysql.com>
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
Author: jstephens
Date: 2008-03-11 02:10:18 +0100 (Tue, 11 Mar 2008)
New Revision: 10187
Log:
More prep for reorganisation:
Added parent and child class links
Fixed wording in abstracts
Minor fixes in titles
Reformat
Modified:
trunk/ndbapi/class-column.xml
trunk/ndbapi/class-datafile.xml
trunk/ndbapi/class-dictionary.xml
trunk/ndbapi/class-event.xml
trunk/ndbapi/class-index.xml
trunk/ndbapi/class-list.xml
trunk/ndbapi/class-logfilegroup.xml
trunk/ndbapi/class-ndb-cluster-connection.xml
trunk/ndbapi/class-ndb.xml
trunk/ndbapi/class-ndbblob.xml
trunk/ndbapi/class-ndbdictionary.xml
trunk/ndbapi/class-ndbeventoperation.xml
trunk/ndbapi/class-ndbindexoperation.xml
trunk/ndbapi/class-ndbindexscanoperation.xml
trunk/ndbapi/class-ndboperation.xml
trunk/ndbapi/class-ndbrecattr.xml
trunk/ndbapi/class-ndbscanfilter.xml
trunk/ndbapi/class-ndbscanoperation.xml
trunk/ndbapi/class-ndbtransaction.xml
trunk/ndbapi/class-object.xml
trunk/ndbapi/class-table.xml
trunk/ndbapi/class-tablespace.xml
trunk/ndbapi/class-template.xml
trunk/ndbapi/class-undofile.xml
trunk/ndbapi/struct-autogrowspecification.xml
trunk/ndbapi/struct-element.xml
trunk/ndbapi/struct-indexbound.xml
trunk/ndbapi/struct-recordspecification.xml
Modified: trunk/ndbapi/class-column.xml
===================================================================
--- trunk/ndbapi/class-column.xml 2008-03-10 23:09:09 UTC (rev 10186)
+++ trunk/ndbapi/class-column.xml 2008-03-11 01:10:18 UTC (rev 10187)
Changed blocks: 2, Lines Added: 21, Lines Deleted: 1; 786 bytes
@@ -21,6 +21,26 @@
+ Parent class
+
+
+ NdbDictionary
+
+
+
+
+
+
+ Child classes
+
+
+ None
+
+
+
+
+
+
Description
@@ -680,7 +700,7 @@
- <literal>Column</literal> Class Methods
+ <literal>Column</literal> Methods
Modified: trunk/ndbapi/class-datafile.xml
===================================================================
--- trunk/ndbapi/class-datafile.xml 2008-03-10 23:09:09 UTC (rev 10186)
+++ trunk/ndbapi/class-datafile.xml 2008-03-11 01:10:18 UTC (rev 10187)
Changed blocks: 2, Lines Added: 21, Lines Deleted: 1; 784 bytes
@@ -21,6 +21,26 @@
+ Parent class
+
+
+ Object
+
+
+
+
+
+
+ Child classes
+
+
+ None
+
+
+
+
+
+
Description
@@ -174,7 +194,7 @@
- <literal>Datafile</literal> Class Methods
+ <literal>Datafile</literal> Methods
Modified: trunk/ndbapi/class-dictionary.xml
===================================================================
--- trunk/ndbapi/class-dictionary.xml 2008-03-10 23:09:09 UTC (rev 10186)
+++ trunk/ndbapi/class-dictionary.xml 2008-03-11 01:10:18 UTC (rev 10187)
Changed blocks: 2, Lines Added: 22, Lines Deleted: 4; 1102 bytes
@@ -14,15 +14,33 @@
- This section describes the Dictionary class and
- its subclasses List and
- Element.
+ This section describes the Dictionary class.
+ Parent class
+
+
+ NdbDictionary
+
+
+
+
+
+
+ Child classes
+
+
+ List
+
+
+
+
+
+
Description
@@ -240,7 +258,7 @@
- <literal>Dictionary</literal> Class Methods
+ <literal>Dictionary</literal> Methods
Modified: trunk/ndbapi/class-event.xml
===================================================================
--- trunk/ndbapi/class-event.xml 2008-03-10 23:09:09 UTC (rev 10186)
+++ trunk/ndbapi/class-event.xml 2008-03-11 01:10:18 UTC (rev 10187)
Changed blocks: 2, Lines Added: 21, Lines Deleted: 1; 923 bytes
@@ -20,6 +20,26 @@
+
+
+ Parent class
+
+
+ NdbDictionary
+
+
+
+
+
+
+ Child classes
+
+
+ None
+
+
+
+
[js] Much more discussion of events is needed or a link here to
same. What's the relationship between Event and EventOperation?
@@ -509,7 +529,7 @@
- <literal>Event</literal> Class Methods
+ <literal>Event</literal> Methods
Modified: trunk/ndbapi/class-index.xml
===================================================================
--- trunk/ndbapi/class-index.xml 2008-03-10 23:09:09 UTC (rev 10186)
+++ trunk/ndbapi/class-index.xml 2008-03-11 01:10:18 UTC (rev 10187)
Changed blocks: 2, Lines Added: 21, Lines Deleted: 1; 780 bytes
@@ -22,6 +22,26 @@
+ Parent class
+
+
+ NdbDictionary
+
+
+
+
+
+
+ Child classes
+
+
+ None
+
+
+
+
+
+
Description
@@ -245,7 +265,7 @@
- <literal>Index</literal> Class Methods
+ <literal>Index</literal> Methods
Modified: trunk/ndbapi/class-list.xml
===================================================================
--- trunk/ndbapi/class-list.xml 2008-03-10 23:09:09 UTC (rev 10186)
+++ trunk/ndbapi/class-list.xml 2008-03-11 01:10:18 UTC (rev 10187)
Changed blocks: 1, Lines Added: 21, Lines Deleted: 2; 827 bytes
@@ -14,14 +14,33 @@
- This section covers the List class, a subclass
- of NdbDictionary::Dictionary.
+ This section covers the List class.
+ Parent class
+
+
+ Dictionary
+
+
+
+
+
+
+ Child classes
+
+
+ None
+
+
+
+
+
+
Description
Modified: trunk/ndbapi/class-logfilegroup.xml
===================================================================
--- trunk/ndbapi/class-logfilegroup.xml 2008-03-10 23:09:09 UTC (rev 10186)
+++ trunk/ndbapi/class-logfilegroup.xml 2008-03-11 01:10:18 UTC (rev 10187)
Changed blocks: 2, Lines Added: 21, Lines Deleted: 1; 822 bytes
@@ -22,6 +22,26 @@
+ Parent class
+
+
+ NdbDictionary
+
+
+
+
+
+
+ Child classes
+
+
+ None
+
+
+
+
+
+
Description
@@ -166,7 +186,7 @@
- <literal>LogfileGroup</literal> Class Methods
+ <literal>LogfileGroup</literal> Methods
Modified: trunk/ndbapi/class-ndb-cluster-connection.xml
===================================================================
--- trunk/ndbapi/class-ndb-cluster-connection.xml 2008-03-10 23:09:09 UTC (rev 10186)
+++ trunk/ndbapi/class-ndb-cluster-connection.xml 2008-03-11 01:10:18 UTC (rev 10187)
Changed blocks: 2, Lines Added: 21, Lines Deleted: 1; 896 bytes
@@ -21,6 +21,26 @@
+ Parent class
+
+
+ None
+
+
+
+
+
+
+ Child classes
+
+
+ None
+
+
+
+
+
+
Description
@@ -277,7 +297,7 @@
- <literal>Ndb_cluster_connection</literal> Class Methods
+ <literal>Ndb_cluster_connection</literal> Methods
Modified: trunk/ndbapi/class-ndb.xml
===================================================================
--- trunk/ndbapi/class-ndb.xml 2008-03-10 23:09:09 UTC (rev 10186)
+++ trunk/ndbapi/class-ndb.xml 2008-03-11 01:10:18 UTC (rev 10187)
Changed blocks: 2, Lines Added: 23, Lines Deleted: 3; 1027 bytes
@@ -14,14 +14,34 @@
- This class represents the NDB kernel; it is the primary class of
- the NDB API.
+ This class represents the NDB kernel; it is the
+ primary class of the NDB API.
+ Parent class
+
+
+ None
+
+
+
+
+
+
+ Child classes
+
+
+ None
+
+
+
+
+
+
Description
@@ -180,7 +200,7 @@
- <literal>Ndb</literal> Class Methods
+ <literal>Ndb</literal> Methods
Modified: trunk/ndbapi/class-ndbblob.xml
===================================================================
--- trunk/ndbapi/class-ndbblob.xml 2008-03-10 23:09:09 UTC (rev 10186)
+++ trunk/ndbapi/class-ndbblob.xml 2008-03-11 01:10:18 UTC (rev 10187)
Changed blocks: 2, Lines Added: 21, Lines Deleted: 1; 761 bytes
@@ -25,6 +25,26 @@
+ Parent class
+
+
+ None
+
+
+
+
+
+
+ Child classes
+
+
+ None
+
+
+
+
+
+
Description
@@ -613,7 +633,7 @@
- <literal>NdbBlob</literal> Class Methods
+ <literal>NdbBlob</literal> Methods
Modified: trunk/ndbapi/class-ndbdictionary.xml
===================================================================
--- trunk/ndbapi/class-ndbdictionary.xml 2008-03-10 23:09:09 UTC (rev 10186)
+++ trunk/ndbapi/class-ndbdictionary.xml 2008-03-11 01:10:18 UTC (rev 10187)
Changed blocks: 1, Lines Added: 22, Lines Deleted: 0; 713 bytes
@@ -29,6 +29,28 @@
+ Parent class
+
+
+ None
+
+
+
+
+
+
+ Child classes
+
+
+ Dictionary,
+ Column,
+ Object
+
+
+
+
+
+
Description
Modified: trunk/ndbapi/class-ndbeventoperation.xml
===================================================================
--- trunk/ndbapi/class-ndbeventoperation.xml 2008-03-10 23:09:09 UTC (rev 10186)
+++ trunk/ndbapi/class-ndbeventoperation.xml 2008-03-11 01:10:18 UTC (rev 10187)
Changed blocks: 2, Lines Added: 21, Lines Deleted: 1; 821 bytes
@@ -24,6 +24,26 @@
+ Parent class
+
+
+ None
+
+
+
+
+
+
+ Child classes
+
+
+ None
+
+
+
+
+
+
Description
@@ -387,7 +407,7 @@
- <literal>NdbEventOperation</literal> Class Methods
+ <literal>NdbEventOperation</literal> Methods
Modified: trunk/ndbapi/class-ndbindexoperation.xml
===================================================================
--- trunk/ndbapi/class-ndbindexoperation.xml 2008-03-10 23:09:09 UTC (rev 10186)
+++ trunk/ndbapi/class-ndbindexoperation.xml 2008-03-11 01:10:18 UTC (rev 10187)
Changed blocks: 2, Lines Added: 21, Lines Deleted: 1; 850 bytes
@@ -22,6 +22,26 @@
+ Parent class
+
+
+ NdbOperation
+
+
+
+
+
+
+ Child classes
+
+
+ None
+
+
+
+
+
+
Description
@@ -137,7 +157,7 @@
- <literal>NdbIndexOperation</literal> Class Methods
+ <literal>NdbIndexOperation</literal> Methods
Modified: trunk/ndbapi/class-ndbindexscanoperation.xml
===================================================================
--- trunk/ndbapi/class-ndbindexscanoperation.xml 2008-03-10 23:09:09 UTC (rev 10186)
+++ trunk/ndbapi/class-ndbindexscanoperation.xml 2008-03-11 01:10:18 UTC (rev 10187)
Changed blocks: 2, Lines Added: 21, Lines Deleted: 1; 882 bytes
@@ -23,6 +23,26 @@
+ Parent class
+
+
+ NdbScanOperation
+
+
+
+
+
+
+ Child classes
+
+
+ None
+
+
+
+
+
+
Description
@@ -243,7 +263,7 @@
- <literal>NdbIndexScanOperation</literal> Class Methods
+ <literal>NdbIndexScanOperation</literal> Methods
Modified: trunk/ndbapi/class-ndboperation.xml
===================================================================
--- trunk/ndbapi/class-ndboperation.xml 2008-03-10 23:09:09 UTC (rev 10186)
+++ trunk/ndbapi/class-ndboperation.xml 2008-03-11 01:10:18 UTC (rev 10187)
Changed blocks: 2, Lines Added: 22, Lines Deleted: 5; 1248 bytes
@@ -15,16 +15,33 @@
This section discusses the NdbOperation class.
- Its subclasses NdbIndexOperation,
- NdbScanOperation, and
- NdbIndexScanOperation are described in
- subsections of this section.
+ Parent class
+
+
+ None
+
+
+
+
+
+
+ Child classes
+
+
+ NdbIndexOperation,
+ NdbScanOperation
+
+
+
+
+
+
<literal>NdbOperation</literal> Subclasses
@@ -476,7 +493,7 @@
- <literal>NdbOperation</literal> Class Methods
+ <literal>NdbOperation</literal> Methods
Modified: trunk/ndbapi/class-ndbrecattr.xml
===================================================================
--- trunk/ndbapi/class-ndbrecattr.xml 2008-03-10 23:09:09 UTC (rev 10186)
+++ trunk/ndbapi/class-ndbrecattr.xml 2008-03-11 01:10:18 UTC (rev 10187)
Changed blocks: 2, Lines Added: 21, Lines Deleted: 1; 779 bytes
@@ -22,6 +22,26 @@
+ Parent class
+
+
+ None
+
+
+
+
+
+
+ Child classes
+
+
+ None
+
+
+
+
+
+
Description
@@ -201,7 +221,7 @@
- <literal>NdbRecAttr</literal> Class Methods
+ <literal>NdbRecAttr</literal> Methods
Modified: trunk/ndbapi/class-ndbscanfilter.xml
===================================================================
--- trunk/ndbapi/class-ndbscanfilter.xml 2008-03-10 23:09:09 UTC (rev 10186)
+++ trunk/ndbapi/class-ndbscanfilter.xml 2008-03-11 01:10:18 UTC (rev 10187)
Changed blocks: 2, Lines Added: 21, Lines Deleted: 1; 797 bytes
@@ -22,6 +22,26 @@
+ Parent class
+
+
+ None
+
+
+
+
+
+
+ Child classes
+
+
+ None
+
+
+
+
+
+
Description
@@ -369,7 +389,7 @@
- <literal>NdbScanFilter</literal> Class Methods
+ <literal>NdbScanFilter</literal> Methods
Modified: trunk/ndbapi/class-ndbscanoperation.xml
===================================================================
--- trunk/ndbapi/class-ndbscanoperation.xml 2008-03-10 23:09:09 UTC (rev 10186)
+++ trunk/ndbapi/class-ndbscanoperation.xml 2008-03-11 01:10:18 UTC (rev 10187)
Changed blocks: 2, Lines Added: 21, Lines Deleted: 1; 891 bytes
@@ -22,6 +22,26 @@
+ Parent class
+
+
+ NdbOperation
+
+
+
+
+
+
+ Child classes
+
+
+ NdbIndexScanOperation
+
+
+
+
+
+
Description
@@ -209,7 +229,7 @@
- <literal>NdbScanOperation</literal> Class Methods
+ <literal>NdbScanOperation</literal> Methods
Modified: trunk/ndbapi/class-ndbtransaction.xml
===================================================================
--- trunk/ndbapi/class-ndbtransaction.xml 2008-03-10 23:09:09 UTC (rev 10186)
+++ trunk/ndbapi/class-ndbtransaction.xml 2008-03-11 01:10:18 UTC (rev 10187)
Changed blocks: 2, Lines Added: 21, Lines Deleted: 1; 803 bytes
@@ -22,6 +22,26 @@
+ Parent class
+
+
+ None
+
+
+
+
+
+
+ Child classes
+
+
+ None
+
+
+
+
+
+
Description
@@ -612,7 +632,7 @@
- <literal>NdbTransaction</literal> Class Methods
+ <literal>NdbTransaction</literal> Methods
Modified: trunk/ndbapi/class-object.xml
===================================================================
--- trunk/ndbapi/class-object.xml 2008-03-10 23:09:09 UTC (rev 10186)
+++ trunk/ndbapi/class-object.xml 2008-03-11 01:10:18 UTC (rev 10187)
Changed blocks: 2, Lines Added: 27, Lines Deleted: 1; 1121 bytes
@@ -22,6 +22,32 @@
+ Parent class
+
+
+ NdbDictionary
+
+
+
+
+
+
+ Child classes
+
+
+ Datafile,
+ Event,
+ Index,
+ LogfileGroup,
+ Table,
+ Tablespace,
+ Undofile
+
+
+
+
+
+
Methods
@@ -570,7 +596,7 @@
- <literal>Object</literal> Class Methods
+ <literal>Object</literal> Methods
Modified: trunk/ndbapi/class-table.xml
===================================================================
--- trunk/ndbapi/class-table.xml 2008-03-10 23:09:09 UTC (rev 10186)
+++ trunk/ndbapi/class-table.xml 2008-03-11 01:10:18 UTC (rev 10187)
Changed blocks: 2, Lines Added: 21, Lines Deleted: 1; 780 bytes
@@ -22,6 +22,26 @@
+ Parent class
+
+
+ NdbDictionary
+
+
+
+
+
+
+ Child classes
+
+
+ None
+
+
+
+
+
+
Description
@@ -409,7 +429,7 @@
- <literal>Table</literal> Class Methods
+ <literal>Table</literal> Methods
Modified: trunk/ndbapi/class-tablespace.xml
===================================================================
--- trunk/ndbapi/class-tablespace.xml 2008-03-10 23:09:09 UTC (rev 10186)
+++ trunk/ndbapi/class-tablespace.xml 2008-03-11 01:10:18 UTC (rev 10187)
Changed blocks: 2, Lines Added: 21, Lines Deleted: 1; 810 bytes
@@ -22,6 +22,26 @@
+ Parent class
+
+
+ NdbDictionary
+
+
+
+
+
+
+ Child classes
+
+
+ None
+
+
+
+
+
+
Description
@@ -178,7 +198,7 @@
- <literal>Tablespace</literal> Class Methods
+ <literal>Tablespace</literal> Methods
Modified: trunk/ndbapi/class-template.xml
===================================================================
--- trunk/ndbapi/class-template.xml 2008-03-10 23:09:09 UTC (rev 10186)
+++ trunk/ndbapi/class-template.xml 2008-03-11 01:10:18 UTC (rev 10187)
Changed blocks: 1, Lines Added: 10, Lines Deleted: 6; 894 bytes
@@ -14,27 +14,31 @@
- Description
+ Parent class
- Class represents a programming class.
+ Parent
- Parent class
+ Child classes
-
+
+ Child
+
- Child classes
+ Description
-
+
+ Class represents a programming class.
+
Modified: trunk/ndbapi/class-undofile.xml
===================================================================
--- trunk/ndbapi/class-undofile.xml 2008-03-10 23:09:09 UTC (rev 10186)
+++ trunk/ndbapi/class-undofile.xml 2008-03-11 01:10:18 UTC (rev 10187)
Changed blocks: 2, Lines Added: 21, Lines Deleted: 1; 798 bytes
@@ -22,6 +22,26 @@
+ Parent class
+
+
+ NdbDictionary
+
+
+
+
+
+
+ Child classes
+
+
+ None
+
+
+
+
+
+
Description
@@ -173,7 +193,7 @@
- <literal>Undofile</literal> Class Methods
+ <literal>Undofile</literal> Methods
Modified: trunk/ndbapi/struct-autogrowspecification.xml
===================================================================
--- trunk/ndbapi/struct-autogrowspecification.xml 2008-03-10 23:09:09 UTC (rev 10186)
+++ trunk/ndbapi/struct-autogrowspecification.xml 2008-03-11 01:10:18 UTC (rev 10187)
Changed blocks: 1, Lines Added: 10, Lines Deleted: 0; 551 bytes
@@ -20,6 +20,16 @@
+
+
+ Parent class
+
+
+ NdbDictionary
+
+
+
+
[js] Need some more info here...
Modified: trunk/ndbapi/struct-element.xml
===================================================================
--- trunk/ndbapi/struct-element.xml 2008-03-10 23:09:09 UTC (rev 10186)
+++ trunk/ndbapi/struct-element.xml 2008-03-11 01:10:18 UTC (rev 10187)
Changed blocks: 1, Lines Added: 11, Lines Deleted: 2; 697 bytes
@@ -18,14 +18,23 @@
- This section discusses the structure
- NdbDictionary::Dictionary::List::Element.
+ This section discusses the Element structure.
+ Parent class
+
+
+ List
+
+
+
+
+
+
Description
Modified: trunk/ndbapi/struct-indexbound.xml
===================================================================
--- trunk/ndbapi/struct-indexbound.xml 2008-03-10 23:09:09 UTC (rev 10186)
+++ trunk/ndbapi/struct-indexbound.xml 2008-03-11 01:10:18 UTC (rev 10187)
Changed blocks: 1, Lines Added: 13, Lines Deleted: 1; 644 bytes
@@ -8,9 +8,21 @@
The <literal>NdbIndexScanOperation::IndexBound</literal> Structure
&mccge-warning-section;
-
+
+
+
+ Parent class
+
+
+ NdbIndexScanOperation
+
+
+
+
+
+
Description
Modified: trunk/ndbapi/struct-recordspecification.xml
===================================================================
--- trunk/ndbapi/struct-recordspecification.xml 2008-03-10 23:09:09 UTC (rev 10186)
+++ trunk/ndbapi/struct-recordspecification.xml 2008-03-11 01:10:18 UTC (rev 10187)
Changed blocks: 1, Lines Added: 13, Lines Deleted: 1; 634 bytes
@@ -8,9 +8,21 @@
<literal>NdbDictionary::RecordSpecification</literal>
&mccge-warning-section;
-
+
+
+
+ Parent class
+
+
+ NdbDictionary
+
+
+
+
+
+
Description