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