fixed a number of doxygen warnings

13 files changed, 113 insertions, 50 deletions

diff --git a/ndb/include/mgmapi/mgmapi.h b/ndb/include/mgmapi/mgmapi.h
index 3bf05ce7ccb..3f8d29e13c1 100644
--- a/ndb/include/mgmapi/mgmapi.h
+++ b/ndb/include/mgmapi/mgmapi.h
@@ -55,8 +55,9 @@
  *   struct ndb_mgm_cluster_state *state= ndb_mgm_get_status(handle);
  *   for(int i=0; i < state->no_of_nodes; i++) 
  *   {
- *     printf("node with ID=%d ", state->node_states[i].node_id);
- *     if(state->node_states[i].version != 0)
+ *     struct ndb_mgm_node_state *node_state= &state->node_states[i];
+ *     printf("node with ID=%d ", node_state->node_id);
+ *     if(node_state->version != 0)
  *       printf("connected\n");
  *     else
  *       printf("not connected\n");
@@ -108,15 +109,15 @@ extern "C" {
    */
   enum ndb_mgm_node_type {
     NDB_MGM_NODE_TYPE_UNKNOWN = -1  /** Node type not known*/
-    ,NDB_MGM_NODE_TYPE_API    /** An application node (API) */
+    ,NDB_MGM_NODE_TYPE_API    /** An application (NdbApi) node */
 #ifndef DOXYGEN_SHOULD_SKIP_INTERNAL
     = NODE_TYPE_API
 #endif
-    ,NDB_MGM_NODE_TYPE_NDB    /** A database node (DB) */
+    ,NDB_MGM_NODE_TYPE_NDB    /** A database node */
 #ifndef DOXYGEN_SHOULD_SKIP_INTERNAL
     = NODE_TYPE_DB
 #endif
-    ,NDB_MGM_NODE_TYPE_MGM    /** A mgmt server node (MGM)*/
+    ,NDB_MGM_NODE_TYPE_MGM    /** A management server node */
 #ifndef DOXYGEN_SHOULD_SKIP_INTERNAL
     = NODE_TYPE_MGM
 #endif
@@ -249,13 +250,15 @@ extern "C" {
 #endif
 
   /**
-   *   Status of a node in the cluster
+   *   Status of a node in the cluster.
    *
    *   Sub-structure in enum ndb_mgm_cluster_state
-   *   returned by ndb_mgm_get_status()
+   *   returned by ndb_mgm_get_status().
    *
-   *   @note @ref node_status, @ref start_phase, @ref dynamic_id 
-   *         and @ref node_group are relevant only for database nodes
+   *   @note <var>node_status</var>, <var>start_phase</var>,
+   *         <var>dynamic_id</var> 
+   *         and <var>node_group</var> are relevant only for database nodes,
+   *         i.e. <var>node_type</var> == @ref NDB_MGM_NODE_TYPE_NDB.
    */
   struct ndb_mgm_node_state {
     /** NDB Cluster node ID*/
@@ -532,11 +535,14 @@ extern "C" {
    * Gets the connectstring used for a connection
    *
    * @note This function returns the default connectstring if no call to 
-   *       ndb_mgm_set_connectstring() has been performed
+   *       ndb_mgm_set_connectstring() has been performed. Also, the
+   *       returned connectstring may be formatted differently.
    *
    * @param   handle         Management handle
+   * @param   buf            Buffer to hold result
+   * @param   buf_sz         Size of buffer.
    *
-   * @return                 connectstring
+   * @return                 connectstring (same as <var>buf</var>)
    */
   const char *ndb_mgm_get_connectstring(NdbMgmHandle handle, char *buf, int buf_sz);
 
@@ -545,6 +551,12 @@ extern "C" {
    * ndb_mgm_set_connectstring().
    *
    * @param   handle        Management handle.
+   * @param   no_retries    Number of retries to connect
+   *                        (0 means connect once).
+   * @param   retry_delay_in_seconds
+   *                        How long to wait until retry is performed.
+   * @param   verbose       Make printout regarding connect retries.
+   *
    * @return                -1 on error.
    */
   int ndb_mgm_connect(NdbMgmHandle handle, int no_retries,
@@ -913,7 +925,6 @@ extern "C" {
    * Exit Single user mode
    *
    * @param   handle        NDB management handle.
-   * @param   nodeId        Node ID of the single user node
    * @param   reply         Reply message.
    *
    * @return                -1 on error.
diff --git a/ndb/include/ndbapi/Ndb.hpp b/ndb/include/ndbapi/Ndb.hpp
index 3ebd0fe40b6..a86c34c06f2 100644
--- a/ndb/include/ndbapi/Ndb.hpp
+++ b/ndb/include/ndbapi/Ndb.hpp
@@ -507,7 +507,8 @@
       are more frequent than each 10 ms, 
       additional support from the operating system is required.
    -# For methods that are affected by the adaptive send alorithm
-      (such as NdbTransaction::execute()), there is a <var>force</var> parameter 
+      (such as NdbTransaction::execute()), there is a <var>force</var> 
+      parameter 
       that overrides its default behaviour in this regard and forces 
       immediate transmission to all nodes. See the inidvidual NDB API class 
       listings for more information.
@@ -1345,10 +1346,9 @@ public:
   int  sendPollNdb(int aMillisecondNumber = WAITFOR_RESPONSE_TIMEOUT,
 		   int minNoOfEventsToWakeup = 1,
 		   int forceSend = 0);
+  /** @} *********************************************************************/
 #endif
   
-  /** @} *********************************************************************/
-
   /** 
    * @name Error Handling
    * @{
diff --git a/ndb/include/ndbapi/NdbBlob.hpp b/ndb/include/ndbapi/NdbBlob.hpp
index f9090cb91ba..271287b765c 100644
--- a/ndb/include/ndbapi/NdbBlob.hpp
+++ b/ndb/include/ndbapi/NdbBlob.hpp
@@ -107,6 +107,9 @@ public:
     Closed = 3,
     Invalid = 9
   };
+  /**
+   * Get the state of a NdbBlob object.
+   */
   State getState();
   /**
    * Inline blob header.
@@ -116,7 +119,7 @@ public:
   };
   /**
    * Prepare to read blob value.  The value is available after execute.
-   * Use getNull to check for NULL and getLength to get the real length
+   * Use getNull() to check for NULL and getLength() to get the real length
    * and to check for truncation.  Sets current read/write position to
    * after the data read.
    */
@@ -129,10 +132,10 @@ public:
    */
   int setValue(const void* data, Uint32 bytes);
   /**
-   * Callback for setActiveHook.  Invoked immediately when the prepared
-   * operation has been executed (but not committed).  Any getValue or
-   * setValue is done first.  The blob handle is active so readData or
-   * writeData etc can be used to manipulate blob value.  A user-defined
+   * Callback for setActiveHook().  Invoked immediately when the prepared
+   * operation has been executed (but not committed).  Any getValue() or
+   * setValue() is done first.  The blob handle is active so readData or
+   * writeData() etc can be used to manipulate blob value.  A user-defined
    * argument is passed along.  Returns non-zero on error.
    */
   typedef int ActiveHook(NdbBlob* me, void* arg);
@@ -195,10 +198,15 @@ public:
   const NdbError& getNdbError() const;
   /**
    * Return info about all blobs in this operation.
+   *
+   * Get first blob in list.
    */
-  // Get first blob in list
   NdbBlob* blobsFirstBlob();
-  // Get next blob in list after this one
+  /**
+   * Return info about all blobs in this operation.
+   *
+   * Get next blob in list. Initialize with blobsFirstBlob().
+   */
   NdbBlob* blobsNextBlob();
 
 private:
diff --git a/ndb/include/ndbapi/NdbDictionary.hpp b/ndb/include/ndbapi/NdbDictionary.hpp
index 2100260dab3..707dbd63f06 100644
--- a/ndb/include/ndbapi/NdbDictionary.hpp
+++ b/ndb/include/ndbapi/NdbDictionary.hpp
@@ -631,7 +631,7 @@ public:
      * Assignment operator, deep copy
      * @param  table  Table to be copied
      */
-    Table& operator=(const Table&);
+    Table& operator=(const Table& table);
 
     /**
      * Name of table
@@ -946,12 +946,12 @@ public:
 #endif
     };
 
-    /*
+    /**
      *  Constructor
      *  @param  name  Name of event
      */
     Event(const char *name);
-    /*
+    /**
      *  Constructor
      *  @param  name  Name of event
      *  @param  table Reference retrieved from NdbDictionary
@@ -994,9 +994,12 @@ public:
      */
     void addTableEvent(const TableEvent te);
     /**
-     * Get/set durability of the event
+     * Set durability of the event
+     */
+    void setDurability(EventDurability);
+    /**
+     * Get durability of the event
      */
-    void setDurability(EventDurability ed);
     EventDurability getDurability() const;
 #ifndef DOXYGEN_SHOULD_SKIP_INTERNAL
     void addColumn(const Column &c);
@@ -1116,6 +1119,13 @@ public:
 
     /**
      * Fetch list of all objects, optionally restricted to given type.
+     *
+     * @param list   List of objects returned in the dictionary
+     * @param type   Restrict returned list to only contain objects of
+     *               this type
+     *
+     * @return       -1 if error.
+     *
      */
     int listObjects(List & list, Object::Type type = Object::TypeUndefined);
     int listObjects(List & list,
@@ -1168,10 +1178,10 @@ public:
     
     /**
      * Create event given defined Event instance
-     * @param Event to create
+     * @param event Event to create
      * @return 0 if successful otherwise -1.
      */
-    int createEvent(const Event &);
+    int createEvent(const Event &event);
 
     /**
      * Drop event with given name
@@ -1199,17 +1209,17 @@ public:
 
     /**
      * Create defined table given defined Table instance
-     * @param Table Table to create
+     * @param table Table to create
      * @return 0 if successful otherwise -1.
      */
-    int createTable(const Table &);
+    int createTable(const Table &table);
 
     /**
      * Drop table given retrieved Table instance
-     * @param Table Table to drop
+     * @param table Table to drop
      * @return 0 if successful otherwise -1.
      */
-    int dropTable(Table &);
+    int dropTable(Table & table);
 
     /**
      * Drop table given table name
@@ -1220,12 +1230,12 @@ public:
     
     /**
      * Alter defined table given defined Table instance
-     * @param Table Table to alter
+     * @param table Table to alter
      * @return  -2 (incompatible version) <br>
      *          -1 general error          <br>
      *           0 success                 
      */
-    int alterTable(const Table &);
+    int alterTable(const Table &table);
 
 #ifndef DOXYGEN_SHOULD_SKIP_INTERNAL
     /**
@@ -1257,10 +1267,10 @@ public:
     
     /**
      * Create index given defined Index instance
-     * @param Index to create
+     * @param index Index to create
      * @return 0 if successful otherwise -1.
      */
-    int createIndex(const Index &);
+    int createIndex(const Index &index);
 
     /**
      * Drop index with given name
diff --git a/ndb/include/ndbapi/NdbError.hpp b/ndb/include/ndbapi/NdbError.hpp
index 698b3c10d57..f67b3c4ccaa 100644
--- a/ndb/include/ndbapi/NdbError.hpp
+++ b/ndb/include/ndbapi/NdbError.hpp
@@ -204,6 +204,7 @@ struct NdbError {
    */
   char * details;
 
+#ifndef DOXYGEN_SHOULD_SKIP_INTERNAL
   NdbError(){
     status = UnknownResult;
     classification = NoError;
@@ -227,6 +228,7 @@ struct NdbError {
     ndberror.details = details;
     return ndberror;
   }
+#endif
 };
 
 class NdbOut& operator <<(class NdbOut&, const NdbError &);
diff --git a/ndb/include/ndbapi/NdbEventOperation.hpp b/ndb/include/ndbapi/NdbEventOperation.hpp
index 4f8a05d589c..55ee96b3144 100644
--- a/ndb/include/ndbapi/NdbEventOperation.hpp
+++ b/ndb/include/ndbapi/NdbEventOperation.hpp
@@ -132,7 +132,7 @@ public:
    *       next() has returned a value greater than
    *       zero. If a specific attribute has not changed the corresponding 
    *       NdbRecAttr will be in state UNDEFINED.  This is checked by 
-   *       NdbRecAttr::isNull() which then returns -1.
+   *       NdbRecAttr::isNULL() which then returns -1.
    *
    * @param anAttrName  Attribute name 
    * @param aValue      If this is non-NULL, then the attribute value 
@@ -144,6 +144,9 @@ public:
    *                    (indicating error).
    */
   NdbRecAttr *getValue(const char *anAttrName, char *aValue = 0);
+  /**
+   * See getValue().
+   */
   NdbRecAttr *getPreValue(const char *anAttrName, char *aValue = 0);
 
   /**
diff --git a/ndb/include/ndbapi/NdbIndexScanOperation.hpp b/ndb/include/ndbapi/NdbIndexScanOperation.hpp
index e1a646fa413..b91a2a90d11 100644
--- a/ndb/include/ndbapi/NdbIndexScanOperation.hpp
+++ b/ndb/include/ndbapi/NdbIndexScanOperation.hpp
@@ -45,7 +45,7 @@ public:
    * @returns 0 for success and -1 for failure
    * @see NdbScanOperation::readTuples
    */ 
-  int readTuples(LockMode = LM_Read,
+  int readTuples(LockMode lock_mode = LM_Read,
 		 Uint32 batch = 0, 
 		 Uint32 parallel = 0,
 		 bool order_by = false,
@@ -90,15 +90,14 @@ public:
    * An index stores also all-NULL keys.  Doing index scan with empty
    * bound set returns all table tuples.
    *
-   * @param attrName    Attribute name, alternatively:
-   * @param anAttrId    Index column id (starting from 0)
+   * @param attr        Attribute name, alternatively:
    * @param type        Type of bound
    * @param value       Pointer to bound value, 0 for NULL
    * @param len         Value length in bytes.
    *                    Fixed per datatype and can be omitted
    * @return            0 if successful otherwise -1
    */
-  int setBound(const char* attr, int type, const void* aValue, Uint32 len = 0);
+  int setBound(const char* attr, int type, const void* value, Uint32 len = 0);
 
   /**
    * Define bound on index key in range scan using index column id.
diff --git a/ndb/include/ndbapi/NdbOperation.hpp b/ndb/include/ndbapi/NdbOperation.hpp
index 06715233726..24af18bb507 100644
--- a/ndb/include/ndbapi/NdbOperation.hpp
+++ b/ndb/include/ndbapi/NdbOperation.hpp
@@ -966,6 +966,7 @@ protected:
 #include <stdlib.h>
 #endif
 
+#ifndef DOXYGEN_SHOULD_SKIP_INTERNAL
 
 inline
 int
@@ -1215,4 +1216,6 @@ NdbOperation::setValue(Uint32 anAttrId, double aPar)
   return setValue(anAttrId, (const char*)&aPar, (Uint32)8);
 }
 
+#endif // doxygen
+
 #endif
diff --git a/ndb/include/ndbapi/NdbRecAttr.hpp b/ndb/include/ndbapi/NdbRecAttr.hpp
index 86f891dca95..43883cc91f2 100644
--- a/ndb/include/ndbapi/NdbRecAttr.hpp
+++ b/ndb/include/ndbapi/NdbRecAttr.hpp
@@ -281,6 +281,8 @@ private:
   const NdbDictionary::Column* m_column;
 };
 
+#ifndef DOXYGEN_SHOULD_SKIP_INTERNAL
+
 inline
 NdbDictionary::Column::Type
 NdbRecAttr::getType() const {
@@ -457,5 +459,7 @@ NdbRecAttr::isNULL() const
 
 class NdbOut& operator <<(class NdbOut&, const NdbRecAttr &);
 
+#endif // ifndef DOXYGEN_SHOULD_SKIP_INTERNAL
+
 #endif
 
diff --git a/ndb/include/ndbapi/NdbScanOperation.hpp b/ndb/include/ndbapi/NdbScanOperation.hpp
index 7e3a0ed18b7..5da717148b5 100644
--- a/ndb/include/ndbapi/NdbScanOperation.hpp
+++ b/ndb/include/ndbapi/NdbScanOperation.hpp
@@ -70,7 +70,8 @@ public:
    * NdbOperation::getValue are updated with values 
    * from the scanned tuple. 
    *
-   * @param  fetchAllowed  If set to false, then fetching is disabled
+   * @param fetchAllowed  If set to false, then fetching is disabled
+   * @param forceSend If true send will occur immediately (see @ref secAdapt)
    *
    * The NDB API will contact the NDB Kernel for more tuples 
    * when necessary to do so unless you set the fetchAllowed 
@@ -122,6 +123,13 @@ public:
    * @return an NdbOperation or NULL.
    */
   NdbOperation* updateCurrentTuple();
+  /**
+   * Update current tuple
+   *
+   * @param updateTrans Transaction that should perform the update
+   *
+   * @return an NdbOperation or NULL.
+   */
   NdbOperation*	updateCurrentTuple(NdbTransaction* updateTrans);
 
   /**
@@ -129,6 +137,13 @@ public:
    * @return 0 on success or -1 on failure
    */
   int deleteCurrentTuple();
+  /**
+   * Delete current tuple
+   *
+   * @param takeOverTransaction Transaction that should perform the delete
+   *
+   * @return 0 on success or -1 on failure
+   */
   int deleteCurrentTuple(NdbTransaction* takeOverTransaction);
   
   /**
diff --git a/ndb/include/ndbapi/NdbTransaction.hpp b/ndb/include/ndbapi/NdbTransaction.hpp
index 78724206b4f..42c8271efee 100644
--- a/ndb/include/ndbapi/NdbTransaction.hpp
+++ b/ndb/include/ndbapi/NdbTransaction.hpp
@@ -796,6 +796,8 @@ private:
   void define_scan_op(NdbIndexScanOperation*);
 };
 
+#ifndef DOXYGEN_SHOULD_SKIP_INTERNAL
+
 inline
 Uint32
 NdbTransaction::get_send_size()
@@ -1034,4 +1036,6 @@ NdbTransaction::ptr2int(){
 
 typedef NdbTransaction NdbConnection;
 
+#endif // ifndef DOXYGEN_SHOULD_SKIP_INTERNAL
+
 #endif
diff --git a/ndb/include/ndbapi/ndb_cluster_connection.hpp b/ndb/include/ndbapi/ndb_cluster_connection.hpp
index dbf34473670..2b59ff1a055 100644
--- a/ndb/include/ndbapi/ndb_cluster_connection.hpp
+++ b/ndb/include/ndbapi/ndb_cluster_connection.hpp
@@ -34,10 +34,10 @@ public:
   /**
    * Create a connection to a cluster of storage nodes
    *
-   * @param specify the connectstring for where to find the
-   *        management server
+   * @param connectstring The connectstring for where to find the
+   *                      management server
    */
-  Ndb_cluster_connection(const char * connect_string = 0);
+  Ndb_cluster_connection(const char * connectstring = 0);
   ~Ndb_cluster_connection();
 
   /**
@@ -66,10 +66,10 @@ public:
   /**
    * Wait until the requested connection with one or more storage nodes is successful
    *
-   * @param time_out_for_first_alive number of seconds to wait until
-   *        first live node is detected
-   * @param timeout_after_first_alive number of seconds to wait after
-   *        first live node is detected
+   * @param timeout_for_first_alive   Number of seconds to wait until
+   *                                  first live node is detected
+   * @param timeout_after_first_alive Number of seconds to wait after
+   *                                  first live node is detected
    *
    * @return = 0 all nodes live,
    *         > 0 at least one node live,
diff --git a/ndb/include/ndbapi/ndberror.h b/ndb/include/ndbapi/ndberror.h
index 2c5a41405db..2225f68f08d 100644
--- a/ndb/include/ndbapi/ndberror.h
+++ b/ndb/include/ndbapi/ndberror.h
@@ -21,6 +21,8 @@
 extern "C" {
 #endif
 
+#ifndef DOXYGEN_SHOULD_SKIP_INTERNAL
+
 typedef enum
 {
   ndberror_st_success = 0,
@@ -93,6 +95,8 @@ const char *ndberror_classification_message(ndberror_classification);
 void ndberror_update(ndberror_struct *);
 int ndb_error_string(int err_no, char *str, unsigned int size);
 
+#endif /* doxygen skip internal*/
+
 #ifdef __cplusplus
 }
 #endif