| List: | Commits | « Previous MessageNext Message » | |
| From: | jon | Date: | March 18 2008 7:29pm |
| Subject: | svn commit - mysqldoc@docsrva: r10302 - trunk/ndbapi | ||
| View as plain text | |||
Author: jstephens Date: 2008-03-18 19:29:59 +0100 (Tue, 18 Mar 2008) New Revision: 10302 Log: Promoted hierarchical class listing to chapter level, now precedes chapter containing class/member descriptions. Added: trunk/ndbapi/ndb-hierarchy.xml Modified: trunk/ndbapi/Makefile.depends trunk/ndbapi/ndb-classes.xml trunk/ndbapi/ndbapi.xml Modified: trunk/ndbapi/Makefile.depends =================================================================== --- trunk/ndbapi/Makefile.depends 2008-03-18 18:13:48 UTC (rev 10301) +++ trunk/ndbapi/Makefile.depends 2008-03-18 18:29:59 UTC (rev 10302) Changed blocks: 4, Lines Added: 50, Lines Deleted: 1; 3530 bytes @@ -784,9 +784,9 @@ ../ndbapi/metadata/class-undofile.idmap \ ../ndbapi/metadata/interface-ndbrecord.idmap \ ../ndbapi/metadata/mgm-api.idmap \ - ../ndbapi/metadata/ndb-classes.idmap \ ../ndbapi/metadata/ndb-errors.idmap \ ../ndbapi/metadata/ndb-examples.idmap \ + ../ndbapi/metadata/ndb-hierarchy.idmap \ ../ndbapi/metadata/ndb-internals.idmap \ ../ndbapi/metadata/overview.idmap \ ../ndbapi/metadata/struct-autogrowspecification.idmap \ @@ -858,6 +858,53 @@ ndb-examples-manprepped.xml: $(ndb_examples_SOURCES) $(ndb_examples_IDMAPS) ndb-examples-remprepped.xml: $(ndb_examples_SOURCES) $(ndb_examples_IDMAPS) +ndb_hierarchy_INCLUDES = \ + ../common/fixedchars.ent \ + ../common/phrases.ent \ + ../refman-common/urls.ent \ + all-entities.ent \ + ndb.en.ent +ndb_hierarchy_IMAGES = +ndb_hierarchy_SOURCES = ndb-hierarchy.xml $(ndb_hierarchy_INCLUDES) +ndb_hierarchy_IDMAPS = \ + ../ndbapi/metadata/class-column.idmap \ + ../ndbapi/metadata/class-datafile.idmap \ + ../ndbapi/metadata/class-dictionary.idmap \ + ../ndbapi/metadata/class-event.idmap \ + ../ndbapi/metadata/class-index.idmap \ + ../ndbapi/metadata/class-list.idmap \ + ../ndbapi/metadata/class-logfilegroup.idmap \ + ../ndbapi/metadata/class-ndb-cluster-connection.idmap \ + ../ndbapi/metadata/class-ndb.idmap \ + ../ndbapi/metadata/class-ndbblob.idmap \ + ../ndbapi/metadata/class-ndbdictionary.idmap \ + ../ndbapi/metadata/class-ndbeventoperation.idmap \ + ../ndbapi/metadata/class-ndbindexoperation.idmap \ + ../ndbapi/metadata/class-ndbindexscanoperation.idmap \ + ../ndbapi/metadata/class-ndboperation.idmap \ + ../ndbapi/metadata/class-ndbrecattr.idmap \ + ../ndbapi/metadata/class-ndbscanfilter.idmap \ + ../ndbapi/metadata/class-ndbscanoperation.idmap \ + ../ndbapi/metadata/class-ndbtransaction.idmap \ + ../ndbapi/metadata/class-object.idmap \ + ../ndbapi/metadata/class-table.idmap \ + ../ndbapi/metadata/class-tablespace.idmap \ + ../ndbapi/metadata/class-undofile.idmap \ + ../ndbapi/metadata/interface-ndbrecord.idmap \ + ../ndbapi/metadata/struct-autogrowspecification.idmap \ + ../ndbapi/metadata/struct-element.idmap \ + ../ndbapi/metadata/struct-indexbound.idmap \ + ../ndbapi/metadata/struct-ndberror.idmap \ + ../ndbapi/metadata/struct-recordspecification.idmap +ndb-hierarchy.validpure: $(ndb_hierarchy_SOURCES) +ndb-hierarchy.titles: $(ndb_hierarchy_SOURCES) +ndb-hierarchy.useless: $(ndb_hierarchy_SOURCES) +ndb-hierarchy.valid: $(ndb_hierarchy_SOURCES) $(ndb_hierarchy_IDMAPS) +ndb-hierarchy.validwarn: $(ndb_hierarchy_SOURCES) $(ndb_hierarchy_IDMAPS) +ndb-hierarchy-prepped.xml: $(ndb_hierarchy_SOURCES) $(ndb_hierarchy_IDMAPS) +ndb-hierarchy-manprepped.xml: $(ndb_hierarchy_SOURCES) $(ndb_hierarchy_IDMAPS) +ndb-hierarchy-remprepped.xml: $(ndb_hierarchy_SOURCES) $(ndb_hierarchy_IDMAPS) + ndb_internals_INCLUDES = \ ../common/fixedchars.ent \ ../common/phrases.ent \ @@ -977,6 +1024,7 @@ ndb-classes.xml \ ndb-errors.xml \ ndb-examples.xml \ + ndb-hierarchy.xml \ ndb-internals.xml \ ndb.en.ent \ overview.xml \ @@ -1052,6 +1100,7 @@ ../ndbapi/metadata/ndb-classes.idmap \ ../ndbapi/metadata/ndb-errors.idmap \ ../ndbapi/metadata/ndb-examples.idmap \ + ../ndbapi/metadata/ndb-hierarchy.idmap \ ../ndbapi/metadata/ndb-internals.idmap \ ../ndbapi/metadata/overview.idmap \ ../ndbapi/metadata/struct-autogrowspecification.idmap \ Modified: trunk/ndbapi/ndb-classes.xml =================================================================== --- trunk/ndbapi/ndb-classes.xml 2008-03-18 18:13:48 UTC (rev 10301) +++ trunk/ndbapi/ndb-classes.xml 2008-03-18 18:29:59 UTC (rev 10302) Changed blocks: 1, Lines Added: 0, Lines Deleted: 220; 6751 bytes @@ -131,224 +131,4 @@ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="struct-recordspecification.xml"/> - <section id="ndb-hierarchy"> - - <title><literal>NDB</literal> Object Hierarachy</title> - - <para> - This section provides a hierarchical listing of all classes, - interfaces, and structures exposed by the <literal>NDB</literal> - API. - </para> - - <para> - <itemizedlist> - - <listitem> - <para> - <link linkend="class-ndb"><literal>Ndb</literal></link> - </para> - </listitem> - - <listitem> - <para> - <link linkend="class-ndbblob"><literal>NdbBlob</literal></link> - </para> - </listitem> - - <listitem> - <para> - <link linkend="class-ndb-cluster-connection"><literal>Ndb_cluster_connection</literal></link> - </para> - </listitem> - - <listitem> - <para> - <link linkend="class-ndbdictionary"><literal>NdbDictionary</literal></link> - - <itemizedlist> - - <listitem> - <para> - <link linkend="struct-autogrowspecification"><literal>AutoGrowSpecification</literal></link> - </para> - </listitem> - - <listitem> - <para> - <link linkend="class-dictionary"><literal>Dictionary</literal></link> - - <itemizedlist> - - <listitem> - <para> - <link linkend="class-list"><literal>List</literal></link> - - <itemizedlist> - - <listitem> - <para> - <link linkend="struct-element"><literal>Element</literal></link> - </para> - </listitem> - - </itemizedlist> - </para> - </listitem> - - </itemizedlist> - </para> - </listitem> - - <listitem> - <para> - <link linkend="class-column"><literal>Column</literal></link> - </para> - </listitem> - - <listitem> - <para> - <link linkend="class-object"><literal>Object</literal></link> - - <itemizedlist> - - <listitem> - <para> - <link linkend="class-datafile"><literal>Datafile</literal></link> - </para> - </listitem> - - <listitem> - <para> - <link linkend="class-event"><literal>Event</literal></link> - </para> - </listitem> - - <listitem> - <para> - <link linkend="class-index"><literal>Index</literal></link> - </para> - </listitem> - - <listitem> - <para> - <link linkend="class-logfilegroup"><literal>LogfileGroup</literal></link> - </para> - </listitem> - - <listitem> - <para> - <link linkend="class-table"><literal>Table</literal></link> - </para> - </listitem> - - <listitem> - <para> - <link linkend="class-tablespace"><literal>Tablespace</literal></link> - </para> - </listitem> - - <listitem> - <para> - <link linkend="class-undofile"><literal>Undofile</literal></link> - </para> - </listitem> - - </itemizedlist> - </para> - </listitem> - - <listitem> - <para> - <link linkend="struct-recordspecification"><literal>RecordSpecification</literal></link> - </para> - </listitem> - - </itemizedlist> - </para> - </listitem> - - <listitem> - <para> - <link linkend="struct-ndberror"><literal>NdbError</literal></link> - </para> - </listitem> - - <listitem> - <para> - <link linkend="class-ndbeventoperation"><literal>NdbEventOperation</literal></link> - </para> - </listitem> - - <listitem> - <para> - <link linkend="class-ndboperation"><literal>NdbOperation</literal></link> - - <itemizedlist> - - <listitem> - <para> - <link linkend="class-ndbindexoperation"><literal>NdbIndexOperation</literal></link> - </para> - </listitem> - - <listitem> - <para> - <link linkend="class-ndbscanoperation"><literal>NdbScanOperation</literal></link> - - <itemizedlist> - - <listitem> - <para> - <link linkend="class-ndbindexscanoperation"><literal>NdbIndexScanOperation</literal></link> - - <itemizedlist> - - <listitem> - <para> - <link linkend="struct-indexbound"><literal>IndexBound</literal></link> - </para> - </listitem> - - </itemizedlist> - </para> - </listitem> - - </itemizedlist> - </para> - </listitem> - - </itemizedlist> - </para> - </listitem> - - <listitem> - <para> - <link linkend="class-ndbrecattr"><literal>NdbRecAttr</literal></link> - </para> - </listitem> - - <listitem> - <para> - <link linkend="interface-ndbrecord"><literal>NdbRecord</literal></link> - </para> - </listitem> - - <listitem> - <para> - <link linkend="class-ndbscanfilter"><literal>NdbScanFilter</literal></link> - </para> - </listitem> - - <listitem> - <para> - <link linkend="class-ndbtransaction"><literal>NdbTransaction</literal></link> - </para> - </listitem> - - </itemizedlist> - </para> - - </section> - </chapter> Added: trunk/ndbapi/ndb-hierarchy.xml =================================================================== --- trunk/ndbapi/ndb-hierarchy.xml (rev 0) +++ trunk/ndbapi/ndb-hierarchy.xml 2008-03-18 18:29:59 UTC (rev 10302) Changed blocks: 1, Lines Added: 223, Lines Deleted: 0; 6516 bytes @@ -0,0 +1,223 @@ +<?xml version="1.0" encoding="utf-8"?> +<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [ +<!ENTITY % all.entities SYSTEM "all-entities.ent"> +%all.entities; +]> +<chapter id="ndb-hierarchy"> + + <title>The <literal>NDB</literal> Object Hierarachy</title> + + <para> + Here we provide a hierarchical listing of all classes, interfaces, + and structures exposed by the <literal>NDB</literal> API. + </para> + + <para> + <itemizedlist> + + <listitem> + <para> + <link linkend="class-ndb"><literal>Ndb</literal></link> + </para> + </listitem> + + <listitem> + <para> + <link linkend="class-ndbblob"><literal>NdbBlob</literal></link> + </para> + </listitem> + + <listitem> + <para> + <link linkend="class-ndb-cluster-connection"><literal>Ndb_cluster_connection</literal></link> + </para> + </listitem> + + <listitem> + <para> + <link linkend="class-ndbdictionary"><literal>NdbDictionary</literal></link> + + <itemizedlist> + + <listitem> + <para> + <link linkend="struct-autogrowspecification"><literal>AutoGrowSpecification</literal></link> + </para> + </listitem> + + <listitem> + <para> + <link linkend="class-dictionary"><literal>Dictionary</literal></link> + + <itemizedlist> + + <listitem> + <para> + <link linkend="class-list"><literal>List</literal></link> + + <itemizedlist> + + <listitem> + <para> + <link linkend="struct-element"><literal>Element</literal></link> + </para> + </listitem> + + </itemizedlist> + </para> + </listitem> + + </itemizedlist> + </para> + </listitem> + + <listitem> + <para> + <link linkend="class-column"><literal>Column</literal></link> + </para> + </listitem> + + <listitem> + <para> + <link linkend="class-object"><literal>Object</literal></link> + + <itemizedlist> + + <listitem> + <para> + <link linkend="class-datafile"><literal>Datafile</literal></link> + </para> + </listitem> + + <listitem> + <para> + <link linkend="class-event"><literal>Event</literal></link> + </para> + </listitem> + + <listitem> + <para> + <link linkend="class-index"><literal>Index</literal></link> + </para> + </listitem> + + <listitem> + <para> + <link linkend="class-logfilegroup"><literal>LogfileGroup</literal></link> + </para> + </listitem> + + <listitem> + <para> + <link linkend="class-table"><literal>Table</literal></link> + </para> + </listitem> + + <listitem> + <para> + <link linkend="class-tablespace"><literal>Tablespace</literal></link> + </para> + </listitem> + + <listitem> + <para> + <link linkend="class-undofile"><literal>Undofile</literal></link> + </para> + </listitem> + + </itemizedlist> + </para> + </listitem> + + <listitem> + <para> + <link linkend="struct-recordspecification"><literal>RecordSpecification</literal></link> + </para> + </listitem> + + </itemizedlist> + </para> + </listitem> + + <listitem> + <para> + <link linkend="struct-ndberror"><literal>NdbError</literal></link> + </para> + </listitem> + + <listitem> + <para> + <link linkend="class-ndbeventoperation"><literal>NdbEventOperation</literal></link> + </para> + </listitem> + + <listitem> + <para> + <link linkend="class-ndboperation"><literal>NdbOperation</literal></link> + + <itemizedlist> + + <listitem> + <para> + <link linkend="class-ndbindexoperation"><literal>NdbIndexOperation</literal></link> + </para> + </listitem> + + <listitem> + <para> + <link linkend="class-ndbscanoperation"><literal>NdbScanOperation</literal></link> + + <itemizedlist> + + <listitem> + <para> + <link linkend="class-ndbindexscanoperation"><literal>NdbIndexScanOperation</literal></link> + + <itemizedlist> + + <listitem> + <para> + <link linkend="struct-indexbound"><literal>IndexBound</literal></link> + </para> + </listitem> + + </itemizedlist> + </para> + </listitem> + + </itemizedlist> + </para> + </listitem> + + </itemizedlist> + </para> + </listitem> + + <listitem> + <para> + <link linkend="class-ndbrecattr"><literal>NdbRecAttr</literal></link> + </para> + </listitem> + + <listitem> + <para> + <link linkend="interface-ndbrecord"><literal>NdbRecord</literal></link> + </para> + </listitem> + + <listitem> + <para> + <link linkend="class-ndbscanfilter"><literal>NdbScanFilter</literal></link> + </para> + </listitem> + + <listitem> + <para> + <link linkend="class-ndbtransaction"><literal>NdbTransaction</literal></link> + </para> + </listitem> + + </itemizedlist> + </para> + +</chapter> Modified: trunk/ndbapi/ndbapi.xml =================================================================== --- trunk/ndbapi/ndbapi.xml 2008-03-18 18:13:48 UTC (rev 10301) +++ trunk/ndbapi/ndbapi.xml 2008-03-18 18:29:59 UTC (rev 10302) Changed blocks: 1, Lines Added: 2, Lines Deleted: 0; 580 bytes @@ -51,6 +51,8 @@ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="getting-started.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="ndb-hierarchy.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="ndb-classes.xml"/> <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="ndb-errors.xml"/>
| Thread | ||
|---|---|---|
| • svn commit - mysqldoc@docsrva: r10302 - trunk/ndbapi | jon | 18 Mar |
© 1995-2008 MySQL AB, 2008-2009 Sun Microsystems, Inc.
Page generated in 0.507 sec. using MySQL 5.1.14-beta-log