Doxygen fixes. Use DISTRIBUTE_GROUP_DOC.

- DISTRIBUTE_GROUP_DOC makes doxygen give several fields the
  same doc: mn_hi + mn_lo in MDB_node.
- With mdb_mutex_t + mdb_mutexref_t, instead split them up.
- Don't hide a doxygen #name inside double quotes.
ntdll
Hallvard Furuseth 8 years ago
parent 72c893fc82
commit be94a7565b
  1. 2
      libraries/liblmdb/Doxyfile
  2. 32
      libraries/liblmdb/mdb.c

@ -253,7 +253,7 @@ IDL_PROPERTY_SUPPORT = YES
# member in the group (if any) for the other members of the group. By default # member in the group (if any) for the other members of the group. By default
# all members of a group must be documented explicitly. # all members of a group must be documented explicitly.
DISTRIBUTE_GROUP_DOC = NO DISTRIBUTE_GROUP_DOC = YES
# Set the SUBGROUPING tag to YES (the default) to allow class member groups of # Set the SUBGROUPING tag to YES (the default) to allow class member groups of
# the same type (for instance a group of public functions) to be put as a # the same type (for instance a group of public functions) to be put as a

@ -417,15 +417,15 @@ mdb_sem_wait(mdb_mutexref_t sem)
#define mdb_mutex_consistent(mutex) 0 #define mdb_mutex_consistent(mutex) 0
#else /* MDB_USE_POSIX_MUTEX: */ #else /* MDB_USE_POSIX_MUTEX: */
/** Shared mutex/semaphore as it is stored (mdb_mutex_t), and as /** Shared mutex/semaphore as the original is stored.
* local variables keep it (mdb_mutexref_t).
* *
* An mdb_mutex_t can be assigned to an mdb_mutexref_t. They can * Not for copies. Instead it can be assigned to an #mdb_mutexref_t.
* be the same, or an array[size 1] and a pointer. * When mdb_mutexref_t is a pointer and mdb_mutex_t is not, then it
* @{ * is array[size 1] so it can be assigned to the pointer.
*/ */
typedef pthread_mutex_t mdb_mutex_t[1], *mdb_mutexref_t; typedef pthread_mutex_t mdb_mutex_t[1];
/* @} */ /** Reference to an #mdb_mutex_t */
typedef pthread_mutex_t *mdb_mutexref_t;
/** Lock the reader or writer mutex. /** Lock the reader or writer mutex.
* Returns 0 or a code to give #mdb_mutex_failed(), as in #LOCK_MUTEX(). * Returns 0 or a code to give #mdb_mutex_failed(), as in #LOCK_MUTEX().
*/ */
@ -463,7 +463,7 @@ typedef pthread_mutex_t mdb_mutex_t[1], *mdb_mutexref_t;
#define Z MDB_FMT_Z /**< printf/scanf format modifier for size_t */ #define Z MDB_FMT_Z /**< printf/scanf format modifier for size_t */
#define Yu MDB_PRIy(u) /**< printf format for #mdb_size_t */ #define Yu MDB_PRIy(u) /**< printf format for #mdb_size_t */
#define Yd MDB_PRIy(d) /**< printf format for "signed #mdb_size_t" */ #define Yd MDB_PRIy(d) /**< printf format for 'signed #mdb_size_t' */
#if defined(_WIN32) || defined(MDB_USE_POSIX_SEM) #if defined(_WIN32) || defined(MDB_USE_POSIX_SEM)
#define MNAME_LEN 32 #define MNAME_LEN 32
@ -973,19 +973,21 @@ typedef struct MDB_page {
/** Header for a single key/data pair within a page. /** Header for a single key/data pair within a page.
* Used in pages of type #P_BRANCH and #P_LEAF without #P_LEAF2. * Used in pages of type #P_BRANCH and #P_LEAF without #P_LEAF2.
* We guarantee 2-byte alignment for 'MDB_node's. * We guarantee 2-byte alignment for 'MDB_node's.
*
* #mn_lo and #mn_hi are used for data size on leaf nodes, and for child
* pgno on branch nodes. On 64 bit platforms, #mn_flags is also used
* for pgno. (Branch nodes have no flags). Lo and hi are in host byte
* order in case some accesses can be optimized to 32-bit word access.
*/ */
typedef struct MDB_node { typedef struct MDB_node {
/** lo and hi are used for data size on leaf nodes and for /** part of data size or pgno
* child pgno on branch nodes. On 64 bit platforms, flags * @{ */
* is also used for pgno. (Branch nodes have no flags).
* They are in host byte order in case that lets some
* accesses be optimized into a 32-bit word access.
*/
#if BYTE_ORDER == LITTLE_ENDIAN #if BYTE_ORDER == LITTLE_ENDIAN
unsigned short mn_lo, mn_hi; /**< part of data size or pgno */ unsigned short mn_lo, mn_hi;
#else #else
unsigned short mn_hi, mn_lo; unsigned short mn_hi, mn_lo;
#endif #endif
/** @} */
/** @defgroup mdb_node Node Flags /** @defgroup mdb_node Node Flags
* @ingroup internal * @ingroup internal
* Flags for node headers. * Flags for node headers.

Loading…
Cancel
Save