Doxygen fixes

incre
Hallvard Furuseth 11 years ago
parent 4ddf2ec831
commit 684bb867ce
  1. 2
      libraries/liblmdb/lmdb.h
  2. 10
      libraries/liblmdb/mdb.c

@ -829,7 +829,7 @@ typedef void MDB_assert_func(MDB_env *env, const char *msg);
* Disabled if liblmdb is buillt with NDEBUG. * Disabled if liblmdb is buillt with NDEBUG.
* @note This hack should become obsolete as lmdb's error handling matures. * @note This hack should become obsolete as lmdb's error handling matures.
* @param[in] env An environment handle returned by #mdb_env_create(). * @param[in] env An environment handle returned by #mdb_env_create().
* @parem[in] func An #MDB_assert_func function, or 0. * @param[in] func An #MDB_assert_func function, or 0.
* @return A non-zero error value on failure and 0 on success. * @return A non-zero error value on failure and 0 on success.
*/ */
int mdb_env_set_assert(MDB_env *env, MDB_assert_func *func); int mdb_env_set_assert(MDB_env *env, MDB_assert_func *func);

@ -352,7 +352,7 @@ static txnid_t mdb_debug_start;
/** @brief The maximum size of a database page. /** @brief The maximum size of a database page.
* *
* This is 32k, since it must fit in #MDB_page.#mp_upper. * This is 32k, since it must fit in #MDB_page.%mp_upper.
* *
* LMDB will use database pages < OS pages if needed. * LMDB will use database pages < OS pages if needed.
* That causes more I/O in write transactions: The OS must * That causes more I/O in write transactions: The OS must
@ -941,7 +941,7 @@ struct MDB_txn {
#define MDB_TXN_SPILLS 0x08 /**< txn or a parent has spilled pages */ #define MDB_TXN_SPILLS 0x08 /**< txn or a parent has spilled pages */
/** @} */ /** @} */
unsigned int mt_flags; /**< @ref mdb_txn */ unsigned int mt_flags; /**< @ref mdb_txn */
/** dirty_list room: Array size - #dirty pages visible to this txn. /** #dirty_list room: Array size - \#dirty pages visible to this txn.
* Includes ancestor txns' dirty pages not hidden by other txns' * Includes ancestor txns' dirty pages not hidden by other txns'
* dirty/spilled pages. Thus commit(nested txn) has room to merge * dirty/spilled pages. Thus commit(nested txn) has room to merge
* dirty_list into mt_parent after freeing hidden mt_parent pages. * dirty_list into mt_parent after freeing hidden mt_parent pages.
@ -1096,7 +1096,7 @@ typedef struct MDB_ntxn {
#define MDB_COMMIT_PAGES IOV_MAX #define MDB_COMMIT_PAGES IOV_MAX
#endif #endif
/* max bytes to write in one call */ /** max bytes to write in one call */
#define MAX_WRITE (0x80000000U >> (sizeof(ssize_t) == 4)) #define MAX_WRITE (0x80000000U >> (sizeof(ssize_t) == 4))
static int mdb_page_alloc(MDB_cursor *mc, int num, MDB_page **mp); static int mdb_page_alloc(MDB_cursor *mc, int num, MDB_page **mp);
@ -6534,8 +6534,7 @@ full:
} }
/** Delete the specified node from a page. /** Delete the specified node from a page.
* @param[in] mp The page to operate on. * @param[in] mc Cursor pointing to the node to delete.
* @param[in] indx The index of the node to delete.
* @param[in] ksize The size of a node. Only used if the page is * @param[in] ksize The size of a node. Only used if the page is
* part of a #MDB_DUPFIXED database. * part of a #MDB_DUPFIXED database.
*/ */
@ -7109,6 +7108,7 @@ mdb_node_move(MDB_cursor *csrc, MDB_cursor *cdst)
* the \b csrc page will be freed. * the \b csrc page will be freed.
* @param[in] csrc Cursor pointing to the source page. * @param[in] csrc Cursor pointing to the source page.
* @param[in] cdst Cursor pointing to the destination page. * @param[in] cdst Cursor pointing to the destination page.
* @return 0 on success, non-zero on failure.
*/ */
static int static int
mdb_page_merge(MDB_cursor *csrc, MDB_cursor *cdst) mdb_page_merge(MDB_cursor *csrc, MDB_cursor *cdst)

Loading…
Cancel
Save