fixed errors in the doxygen comments

parent 12e7f8ef
...@@ -52,12 +52,15 @@ ...@@ -52,12 +52,15 @@
The execute can be of two different types, The execute can be of two different types,
<em>Commit</em> or <em>NoCommit</em>. <em>Commit</em> or <em>NoCommit</em>.
*/
#ifndef DOXYGEN_SHOULD_SKIP_INTERNAL #ifndef DOXYGEN_SHOULD_SKIP_INTERNAL
/**
(The execute can also be divided into three (The execute can also be divided into three
steps: prepare, send, and poll to get asynchronous steps: prepare, send, and poll to get asynchronous
transactions. More about this later.) transactions. More about this later.)
*/
#endif #endif
/**
If the execute is of type NoCommit, If the execute is of type NoCommit,
then the application program executes part of a transaction, then the application program executes part of a transaction,
but without committing the transaction. but without committing the transaction.
...@@ -91,22 +94,27 @@ ...@@ -91,22 +94,27 @@
To execute several parallel synchronous transactions, one can either To execute several parallel synchronous transactions, one can either
use multiple Ndb objects in several threads or start multiple use multiple Ndb objects in several threads or start multiple
applications programs. applications programs.
*/
#ifndef DOXYGEN_SHOULD_SKIP_INTERNAL #ifndef DOXYGEN_SHOULD_SKIP_INTERNAL
/**
Another way to execute several parallel transactions is to use Another way to execute several parallel transactions is to use
asynchronous transactions. asynchronous transactions.
*/
#endif #endif
/**
@section secNdbOperations Operations @section secNdbOperations Operations
Each transaction (NdbTransaction object) consist of a list of Each transaction (NdbTransaction object) consist of a list of
operations (Ndb*Operation objects). operations (Ndb*Operation objects).
*/
#ifndef DOXYGEN_SHOULD_SKIP_INTERNAL #ifndef DOXYGEN_SHOULD_SKIP_INTERNAL
/**
Operations are of two different kinds: Operations are of two different kinds:
-# standard operations, and -# standard operations, and
-# interpreted program operations. -# interpreted program operations.
*/
#endif #endif
/**
<h3>Single row operations</h3> <h3>Single row operations</h3>
After the operation is created using NdbTransaction::getNdbOperation After the operation is created using NdbTransaction::getNdbOperation
(or NdbTransaction::getNdbIndexOperation), (or NdbTransaction::getNdbIndexOperation),
...@@ -208,8 +216,9 @@ ...@@ -208,8 +216,9 @@
Ndb::closeTransaction have been called. Ndb::closeTransaction have been called.
The result of reading data from an NdbRecAttr object before The result of reading data from an NdbRecAttr object before
calling NdbTransaction::execute is undefined. calling NdbTransaction::execute is undefined.
*/
#ifndef DOXYGEN_SHOULD_SKIP_INTERNAL #ifndef DOXYGEN_SHOULD_SKIP_INTERNAL
/**
<h3>Interpreted Program Operations</h3> <h3>Interpreted Program Operations</h3>
The following types of interpreted program operations exist: The following types of interpreted program operations exist:
-# NdbOperation::interpretedUpdateTuple : -# NdbOperation::interpretedUpdateTuple :
...@@ -270,8 +279,9 @@ ...@@ -270,8 +279,9 @@
There might be zero NdbOperation::getValue calls. There might be zero NdbOperation::getValue calls.
-# The fifth step is possible subroutine definitions using -# The fifth step is possible subroutine definitions using
NdbOperation::def_subroutine and NdbOperation::ret_sub. NdbOperation::def_subroutine and NdbOperation::ret_sub.
*/
#endif #endif
/**
@subsection secScan Scanning @subsection secScan Scanning
The most common use of interpreted programs is for scanning The most common use of interpreted programs is for scanning
tables. Scanning is a search of all tuples in a table. tables. Scanning is a search of all tuples in a table.
...@@ -386,8 +396,9 @@ ...@@ -386,8 +396,9 @@
See the scan example program in @ref ndbapi_scan.cppn for example See the scan example program in @ref ndbapi_scan.cppn for example
usage of the new scan api. usage of the new scan api.
*/
#ifndef DOXYGEN_SHOULD_SKIP_INTERNAL #ifndef DOXYGEN_SHOULD_SKIP_INTERNAL
/**
<h3>Interpreted Programs</h3> <h3>Interpreted Programs</h3>
Interpretation programs are executed in a Interpretation programs are executed in a
register-based virtual machine. register-based virtual machine.
...@@ -458,9 +469,11 @@ ...@@ -458,9 +469,11 @@
The parameter used by NdbOperation::def_subroutine The parameter used by NdbOperation::def_subroutine
should match the automatic numbering to make it easier to should match the automatic numbering to make it easier to
debug the interpreted program. debug the interpreted program.
*/
#endif #endif
#ifndef DOXYGEN_SHOULD_SKIP_INTERNAL #ifndef DOXYGEN_SHOULD_SKIP_INTERNAL
/**
@section secAsync Asynchronous Transactions @section secAsync Asynchronous Transactions
The asynchronous interface is used to increase the speed of The asynchronous interface is used to increase the speed of
transaction executing by better utilizing the connection transaction executing by better utilizing the connection
...@@ -560,8 +573,10 @@ ...@@ -560,8 +573,10 @@
More about how transactions are send the NDB Kernel is More about how transactions are send the NDB Kernel is
available in section @ref secAdapt. available in section @ref secAdapt.
*/
#endif #endif
/**
@section secError Error Handling @section secError Error Handling
Errors can occur when Errors can occur when
...@@ -1012,8 +1027,7 @@ public: ...@@ -1012,8 +1027,7 @@ public:
Ndb(Ndb_cluster_connection *ndb_cluster_connection, Ndb(Ndb_cluster_connection *ndb_cluster_connection,
const char* aCatalogName = "", const char* aSchemaName = "def"); const char* aCatalogName = "", const char* aSchemaName = "def");
#ifndef DOXYGEN_SHOULD_SKIP_INTERNAL #ifndef DOXYGEN_SHOULD_SKIP_DEPRECATED
// depricated
Ndb(const char* aCatalogName = "", const char* aSchemaName = "def"); Ndb(const char* aCatalogName = "", const char* aSchemaName = "def");
#endif #endif
~Ndb(); ~Ndb();
...@@ -1091,8 +1105,7 @@ public: ...@@ -1091,8 +1105,7 @@ public:
*/ */
int init(int maxNoOfTransactions = 4); int init(int maxNoOfTransactions = 4);
#ifndef DOXYGEN_SHOULD_SKIP_INTERNAL #ifndef DOXYGEN_SHOULD_SKIP_DEPRECATED
// depricated
/** /**
* Wait for Ndb object to successfully set-up connections to * Wait for Ndb object to successfully set-up connections to
* the NDB kernel. * the NDB kernel.
...@@ -1230,8 +1243,9 @@ public: ...@@ -1230,8 +1243,9 @@ public:
* *
* @note should be called after the transaction has completed, irrespective * @note should be called after the transaction has completed, irrespective
* of success or failure * of success or failure
* */
#ifndef DOXYGEN_SHOULD_SKIP_INTERNAL #ifndef DOXYGEN_SHOULD_SKIP_INTERNAL
/**
* @note It is not allowed to call Ndb::closeTransaction after sending the * @note It is not allowed to call Ndb::closeTransaction after sending the
* transaction asynchronously with either * transaction asynchronously with either
* Ndb::sendPreparedTransactions or * Ndb::sendPreparedTransactions or
...@@ -1240,8 +1254,8 @@ public: ...@@ -1240,8 +1254,8 @@ public:
* outstanding transactions and wait until all of them * outstanding transactions and wait until all of them
* has completed before calling Ndb::closeTransaction). * has completed before calling Ndb::closeTransaction).
* If the transaction is not committed it will be aborted. * If the transaction is not committed it will be aborted.
#endif
*/ */
#endif
void closeTransaction(NdbTransaction*); void closeTransaction(NdbTransaction*);
/** @} *********************************************************************/ /** @} *********************************************************************/
......
...@@ -88,10 +88,13 @@ class NdbColumnImpl; ...@@ -88,10 +88,13 @@ class NdbColumnImpl;
* - lock mode vs allowed operation is not checked * - lock mode vs allowed operation is not checked
* - too many pending blob ops can blow up i/o buffers * - too many pending blob ops can blow up i/o buffers
* - table and its blob part tables are not created atomically * - table and its blob part tables are not created atomically
*/
#ifndef DOXYGEN_SHOULD_SKIP_INTERNAL #ifndef DOXYGEN_SHOULD_SKIP_INTERNAL
/**
* - there is no support for an asynchronous interface * - there is no support for an asynchronous interface
#endif
*/ */
#endif
class NdbBlob { class NdbBlob {
public: public:
/** /**
......
...@@ -693,22 +693,26 @@ public: ...@@ -693,22 +693,26 @@ public:
*/ */
unsigned getNoOfColumns() const; unsigned getNoOfColumns() const;
#ifndef DOXYGEN_SHOULD_SKIP_DEPRECATED
/** /**
* Get the number of columns in the index * Get the number of columns in the index
* Depricated, use getNoOfColumns instead. * Depricated, use getNoOfColumns instead.
*/ */
int getNoOfIndexColumns() const; int getNoOfIndexColumns() const;
#endif
/** /**
* Get a specific column in the index * Get a specific column in the index
*/ */
const Column * getColumn(unsigned no) const ; const Column * getColumn(unsigned no) const ;
#ifndef DOXYGEN_SHOULD_SKIP_DEPRECATED
/** /**
* Get a specific column name in the index * Get a specific column name in the index
* Depricated, use getColumn instead. * Depricated, use getColumn instead.
*/ */
const char * getIndexColumn(int no) const ; const char * getIndexColumn(int no) const ;
#endif
/** /**
* Add a column to the index definition * Add a column to the index definition
...@@ -724,6 +728,7 @@ public: ...@@ -724,6 +728,7 @@ public:
*/ */
void addColumnName(const char * name); void addColumnName(const char * name);
#ifndef DOXYGEN_SHOULD_SKIP_DEPRECATED
/** /**
* Add a column name to the index definition * Add a column name to the index definition
* Note that the order of indexes will be in * Note that the order of indexes will be in
...@@ -731,6 +736,7 @@ public: ...@@ -731,6 +736,7 @@ public:
* Depricated, use addColumnName instead. * Depricated, use addColumnName instead.
*/ */
void addIndexColumn(const char * name); void addIndexColumn(const char * name);
#endif
/** /**
* Add several column names to the index definition * Add several column names to the index definition
...@@ -739,6 +745,7 @@ public: ...@@ -739,6 +745,7 @@ public:
*/ */
void addColumnNames(unsigned noOfNames, const char ** names); void addColumnNames(unsigned noOfNames, const char ** names);
#ifndef DOXYGEN_SHOULD_SKIP_DEPRECATED
/** /**
* Add several column names to the index definition * Add several column names to the index definition
* Note that the order of indexes will be in * Note that the order of indexes will be in
...@@ -746,6 +753,7 @@ public: ...@@ -746,6 +753,7 @@ public:
* Depricated, use addColumnNames instead. * Depricated, use addColumnNames instead.
*/ */
void addIndexColumns(int noOfNames, const char ** names); void addIndexColumns(int noOfNames, const char ** names);
#endif
/** /**
* Represents type of index * Represents type of index
......
...@@ -26,14 +26,12 @@ class NdbTransaction; ...@@ -26,14 +26,12 @@ class NdbTransaction;
class NdbReceiver class NdbReceiver
{ {
#ifndef DOXYGEN_SHOULD_SKIP_INTERNAL
friend class Ndb; friend class Ndb;
friend class NdbOperation; friend class NdbOperation;
friend class NdbScanOperation; friend class NdbScanOperation;
friend class NdbIndexOperation; friend class NdbIndexOperation;
friend class NdbIndexScanOperation; friend class NdbIndexScanOperation;
friend class NdbTransaction; friend class NdbTransaction;
#endif
public: public:
enum ReceiverType { NDB_UNINITIALIZED, enum ReceiverType { NDB_UNINITIALIZED,
NDB_OPERATION = 1, NDB_OPERATION = 1,
...@@ -147,5 +145,5 @@ NdbReceiver::execSCANOPCONF(Uint32 tcPtrI, Uint32 len, Uint32 rows){ ...@@ -147,5 +145,5 @@ NdbReceiver::execSCANOPCONF(Uint32 tcPtrI, Uint32 len, Uint32 rows){
return (tmp == len ? 1 : 0); return (tmp == len ? 1 : 0);
} }
#endif #endif // DOXYGEN_SHOULD_SKIP_INTERNAL
#endif #endif
...@@ -14,18 +14,6 @@ ...@@ -14,18 +14,6 @@
along with this program; if not, write to the Free Software along with this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA */ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA */
/*****************************************************************************
* Name: NdbScanOperation.hpp
* Include:
* Link:
* Author: Martin Sköld
* Date: 2002-04-01
* Version: 0.1
* Description: Table scan support
* Documentation:
* Adjust: 2002-04-01 Martin Sköld First version.
****************************************************************************/
#ifndef NdbScanOperation_H #ifndef NdbScanOperation_H
#define NdbScanOperation_H #define NdbScanOperation_H
......
...@@ -362,7 +362,9 @@ public: ...@@ -362,7 +362,9 @@ public:
/** /**
* Close transaction * Close transaction
*/
#ifndef DOXYGEN_SHOULD_SKIP_INTERNAL #ifndef DOXYGEN_SHOULD_SKIP_INTERNAL
/**
* @note It is not allowed to call NdbTransaction::close after sending the * @note It is not allowed to call NdbTransaction::close after sending the
* transaction asynchronously before the callback method has * transaction asynchronously before the callback method has
* been called. * been called.
...@@ -370,8 +372,8 @@ public: ...@@ -370,8 +372,8 @@ public:
* outstanding transactions and wait until all of them * outstanding transactions and wait until all of them
* has completed before calling NdbTransaction::close). * has completed before calling NdbTransaction::close).
* If the transaction is not committed it will be aborted. * If the transaction is not committed it will be aborted.
#endif
*/ */
#endif
void close(); void close();
/** /**
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment