Author: jstephens
Date: 2006-06-20 10:56:07 +0200 (Tue, 20 Jun 2006)
New Revision: 2430
Log:
Added new subsection for NdbDictionary::AutoGrowSpecification struct.
Updated Makefile.
Modified:
trunk/ndbapi/Makefile
trunk/ndbapi/ndb-classes.xml
Modified: trunk/ndbapi/Makefile
===================================================================
--- trunk/ndbapi/Makefile 2006-06-20 07:23:33 UTC (rev 2429)
+++ trunk/ndbapi/Makefile 2006-06-20 08:56:07 UTC (rev 2430)
@@ -29,7 +29,7 @@
# Dependency list for NDB API document
# This variable is updated by "make depend"
-NDBAPI_SRCS = $(NDBAPI_SRCS_EXTRA) ndbapi.xml overview.xml tips-tricks-problems.xml mgm-api.xml ndb-classes.xml images/Ndb-class.png images/Ndb-cluster-connection-class.png images/NdbBlob-class.png images/NdbDictionary-classes.png images/NdbDictionary-Column-class.png images/NdbDictionary-Object-class.png images/NdbDictionary-Object-Index-class.png images/NdbDictionary-Object-Table-class.png errors.xml examples.xml
+NDBAPI_SRCS = $(NDBAPI_SRCS_EXTRA) ndbapi.xml overview.xml tips-tricks-problems.xml mgm-api.xml ndb-classes.xml images/Ndb-class.png images/Ndb-cluster-connection-class.png images/NdbBlob-class.png images/NdbDictionary-classes.png images/NdbDictionary-Column-class.png images/NdbDictionary-Object-class.png images/NdbDictionary-Object-Event-class.png images/NdbDictionary-Object-Index-class.png images/NdbDictionary-Object-Table-class.png images/NdbDictionary-AutoGrowSpecification-struct.png errors.xml examples.xml
ndbapi-prepped.xml: $(NDBAPI_SRCS)
Modified: trunk/ndbapi/ndb-classes.xml
===================================================================
--- trunk/ndbapi/ndb-classes.xml 2006-06-20 07:23:33 UTC (rev 2429)
+++ trunk/ndbapi/ndb-classes.xml 2006-06-20 08:56:07 UTC (rev 2430)
@@ -15248,7 +15248,91 @@
</section>
</section>
-
+
+ <section id="struct-autogrowspecification">
+ <title>The <literal>AutoGrowSpecification</literal> Structure</title>
+
+ <abstract>
+ <para>
+ This section describes the <literal>AutoGrowSpecification</literal> structure.
+ </para>
+ </abstract>
+
+ <remark role="todo">
+ [js] Need some more info here...
+ </remark>
+
+ <formalpara>
+ <title>Description</title>
+ <para>
+ The <literal>AutoGrowSpecification</literal> is a data
+ structure defined in the <literal>NdbDictionary</literal>
+ class, and is used as a parameter to or return value of some
+ of the methods of the <literal>Tablespace</literal> and
+ <literal>LogfileGroup</literal> classes. See
+ <xref linkend="class-tablespace"/>, and
+ <xref linkend="class-logfilegroup"/>, for more information.
+ </para>
+ </formalpara>
+
+ <remark role="todo">
+ [js] Need descriptions of members - none in source.
+ </remark>
+
+ <formalpara>
+ <title>Public Members</title>
+ <para>
+ <literal>AutoGrowSpecification</literal> has the following
+ members, whose types are as shown in the following diagram:
+ <mediaobject>
+ <imageobject>
+ <imagedata
+ fileref="images/NdbDictionary-AutoGrowSpecification-struct.png" format="PNG"/>
+ </imageobject>
+ <textobject>
+ <phrase lang="en">Members of the data structure
+ <literal>AutoGrowSpecification</literal>.</phrase>
+ </textobject>
+ </mediaobject>
+ The purpose and use of each member can be found in the
+ following table:
+ <informaltable>
+ <tgroup cols="2">
+ <colspec colwidth="35*"/>
+ <colspec colwidth="65*"/>
+ <thead>
+ <row>
+ <entry>Name</entry>
+ <entry>Description</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry><literal>min_free</literal></entry>
+ <entry>???</entry>
+ </row>
+ <row>
+ <entry><literal>max_size</literal></entry>
+ <entry>???</entry>
+ </row>
+ <row>
+ <entry><literal>file_size</literal></entry>
+ <entry>???</entry>
+ </row>
+ <row>
+ <entry><literal>filename_pattern</literal></entry>
+ <entry>???</entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+ </para>
+ </formalpara>
+
+
+ </section>
+
+
</section>
<section id="class-ndbeventoperation">
| Thread |
|---|
| • svn commit - mysqldoc@docsrva: r2430 - trunk/ndbapi | jon | 20 Jun |
