From 684bb867ced9f0ccde0268b6a3e839ebcb00ff6b Mon Sep 17 00:00:00 2001 From: Hallvard Furuseth Date: Sun, 16 Mar 2014 12:42:42 +0100 Subject: [PATCH] Doxygen fixes --- libraries/liblmdb/lmdb.h | 2 +- libraries/liblmdb/mdb.c | 10 +++++----- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/libraries/liblmdb/lmdb.h b/libraries/liblmdb/lmdb.h index 2ece805..794269e 100644 --- a/libraries/liblmdb/lmdb.h +++ b/libraries/liblmdb/lmdb.h @@ -829,7 +829,7 @@ typedef void MDB_assert_func(MDB_env *env, const char *msg); * Disabled if liblmdb is buillt with NDEBUG. * @note This hack should become obsolete as lmdb's error handling matures. * @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. */ int mdb_env_set_assert(MDB_env *env, MDB_assert_func *func); diff --git a/libraries/liblmdb/mdb.c b/libraries/liblmdb/mdb.c index fd0a3b5..03ad2cc 100644 --- a/libraries/liblmdb/mdb.c +++ b/libraries/liblmdb/mdb.c @@ -352,7 +352,7 @@ static txnid_t mdb_debug_start; /** @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. * 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 */ /** @} */ 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' * dirty/spilled pages. Thus commit(nested txn) has room to merge * 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 #endif - /* max bytes to write in one call */ + /** max bytes to write in one call */ #define MAX_WRITE (0x80000000U >> (sizeof(ssize_t) == 4)) 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. - * @param[in] mp The page to operate on. - * @param[in] indx The index of the node to delete. + * @param[in] mc Cursor pointing to the node to delete. * @param[in] ksize The size of a node. Only used if the page is * 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. * @param[in] csrc Cursor pointing to the source page. * @param[in] cdst Cursor pointing to the destination page. + * @return 0 on success, non-zero on failure. */ static int mdb_page_merge(MDB_cursor *csrc, MDB_cursor *cdst)