Merge tulin@bk-internal.mysql.com:/home/bk/mysql-5.0

into poseidon.ndb.mysql.com:/home/tomas/mysql-5.0

ndb/include/ndbapi/NdbConnection.hpp

@@ -31,6 +31,8 @@ class Ndb;
 class NdbBlob;
 
 
+#ifndef DOXYGEN_SHOULD_SKIP_INTERNAL
+// to be documented later
 /**
  * NdbAsynchCallback functions are used when executing asynchronous 
  * transactions (using NdbConnection::executeAsynchPrepare, or 
@@ -39,6 +41,7 @@ class NdbBlob;
  * See @ref secAsync for more information.
  */
 typedef void (* NdbAsynchCallback)(int, NdbConnection*, void*);
+#endif
 
 /**
  * Commit type of transaction
@@ -184,7 +187,8 @@ public:
    * @note All operations within the same transaction need to 
    *       be initialized with this method.
    * 
-   * @param  aTable  A table object (fetched by NdbDictionary::Dictionary::getTable)
+   * @param  aTable  
+   *         A table object (fetched by NdbDictionary::Dictionary::getTable)
    * @return  Pointer to an NdbOperation object if successful, otherwise NULL.
    */
   NdbOperation* getNdbOperation(const NdbDictionary::Table * aTable);
@@ -204,7 +208,8 @@ public:
    * get the NdbConnection object which
    * was fetched by startTransaction pointing to this operation.
    *
-   * @param  aTable  A table object (fetched by NdbDictionary::Dictionary::getTable)
+   * @param  aTable  
+   *         A table object (fetched by NdbDictionary::Dictionary::getTable)
    * @return pointer to an NdbOperation object if successful, otherwise NULL
    */
   NdbScanOperation* getNdbScanOperation(const NdbDictionary::Table * aTable);
@@ -226,12 +231,15 @@ public:
    * get the NdbConnection object which
    * was fetched by startTransaction pointing to this operation.
    *
-   * @param  anIndex  An index object (fetched by NdbDictionary::Dictionary::getIndex).
-   * @param  aTable A table object (fetched by NdbDictionary::Dictionary::getTable).
+   * @param  anIndex  
+             An index object (fetched by NdbDictionary::Dictionary::getIndex).
+   * @param  aTable 
+             A table object (fetched by NdbDictionary::Dictionary::getTable).
    * @return pointer to an NdbOperation object if successful, otherwise NULL
    */
-  NdbIndexScanOperation* getNdbIndexScanOperation(const NdbDictionary::Index * anIndex,
-						  const NdbDictionary::Table * aTable);
+  NdbIndexScanOperation* getNdbIndexScanOperation
+  (const NdbDictionary::Index * anIndex,
+   const NdbDictionary::Table * aTable);
   
   /**
    * Get an operation from NdbIndexOperation idlelist and 
@@ -251,8 +259,10 @@ public:
    * get the NdbConnection object that
    * was fetched by startTransaction pointing to this operation.
    *
-   * @param   anIndex   An index object (fetched by NdbDictionary::Dictionary::getIndex).
-   * @param   aTable    A table object (fetched by NdbDictionary::Dictionary::getTable).
+   * @param   anIndex   
+   *          An index object (fetched by NdbDictionary::Dictionary::getIndex).
+   * @param   aTable    
+   *          A table object (fetched by NdbDictionary::Dictionary::getTable).
    * @return              Pointer to an NdbIndexOperation object if 
    *                      successful, otherwise NULL
    */
@@ -289,6 +299,8 @@ public:
 	      AbortOption abortOption = AbortOnError,
 	      int force = 0 );
 
+#ifndef DOXYGEN_SHOULD_SKIP_INTERNAL
+  // to be documented later
   /**
    * Prepare an asynchronous transaction.
    *
@@ -334,7 +346,7 @@ public:
 		     NdbAsynchCallback   aCallback,
 		     void*               anyObject,
 		     AbortOption abortOption = AbortOnError);
-
+#endif
   /**
    * Refresh
    * Update timeout counter of this transaction 
@@ -397,14 +409,14 @@ public:
    *         (Note that there has to be an NdbConnection::execute call 
    *         with Ndb::Commit for the GCI to be available.)
    */
-  int		getGCI();	
+  int		getGCI();
 			
   /**
    * Get transaction identity.
    *
    * @return  Transaction id.
    */
-  Uint64	getTransactionId();			
+  Uint64	getTransactionId();
 
   /**
    * Returns the commit status of the transaction.

ndb/include/ndbapi/NdbDictionary.hpp

@@ -166,7 +166,7 @@ public:
      * The builtin column types
      */
     enum Type {
-      Undefined=0,///< Undefined 
+      Undefined=0,   ///< Undefined 
       Tinyint,       ///< 8 bit. 1 byte signed integer, can be used in array
       Tinyunsigned,  ///< 8 bit. 1 byte unsigned integer, can be used in array
       Smallint,      ///< 16 bit. 2 byte signed integer, can be used in array
@@ -373,16 +373,11 @@ public:
 #ifndef DOXYGEN_SHOULD_SKIP_INTERNAL
     const Table * getBlobTable() const;
 
-    /** 
-     * @name ODBC Specific methods 
-     * @{
-     */
-    void setAutoIncrement(bool);         
+    void setAutoIncrement(bool);
     bool getAutoIncrement() const;
     void setAutoIncrementInitialValue(Uint64 val);
     void setDefaultValue(const char*);   
     const char* getDefaultValue() const;
-    /** @} *******************************************************************/
 
     static const Column * FRAGMENT;
     static const Column * ROW_COUNT;

ndb/include/ndbapi/NdbEventOperation.hpp

@@ -64,7 +64,7 @@ class NdbEventOperationImpl;
  *
  * Known issues:
  *
- * When several NdbEventOperation s are tied to the same event in the same
+ * When several NdbEventOperation's are tied to the same event in the same
  * process they will share the circular buffer. The BufferLength will then
  * be the same for all and decided by the first NdbEventOperation 
  * instantiation. Just make sure to instantiate the "largest" one first.
@@ -84,7 +84,7 @@ class NdbEventOperationImpl;
  * replica.  If a node fails events will not be received twice anymore
  * for data in corresponding fragment. Will be optimized in later versions.
  *
- * If a nodefailiure has occured not all events will be recieved
+ * If a node failure has occured not all events will be recieved
  * anymore. Drop NdbEventOperation and Create again after nodes are up
  * again. Will be fixed in later versions.
  *
@@ -97,7 +97,7 @@ class NdbEventOperationImpl;
  *
  * Useful API programs:
  *
- * select_all -d sys 'NDB$EVENTS_0'
+ * ndb_select_all -d sys 'NDB$EVENTS_0'
  * Will show contents in the system table containing created events.
  *
  */
@@ -187,8 +187,19 @@ public:
    */
   NdbDictionary::Event::TableEvent getEventType();
 
+  /**
+   *
+   */
   Uint32 getGCI();
+
+  /**
+   *
+   */
   Uint32 getLatestGCI();
+
+  /*
+   *
+   */
   void print();
 
 private: