From: Howard Chu Date: Wed, 28 Nov 2012 23:34:19 +0000 (-0800) Subject: Doc layout tweaks X-Git-Tag: OPENLDAP_REL_ENG_2_4_34~103^2~6 X-Git-Url: https://git.sur5r.net/?a=commitdiff_plain;h=049b145ec77f0cde208a2b63baf8adb2090ce9ce;p=openldap Doc layout tweaks --- diff --git a/libraries/libmdb/mdb.h b/libraries/libmdb/mdb.h index 332003462d..784c5ee0ad 100644 --- a/libraries/libmdb/mdb.h +++ b/libraries/libmdb/mdb.h @@ -2,6 +2,8 @@ * @brief memory-mapped database library * * @mainpage MDB Memory-Mapped Database Manager + * + * @section intro_sec Introduction * MDB is a Btree-based database management library modeled loosely on the * BerkeleyDB API, but much simplified. The entire database is exposed * in a memory map, and all data fetches return data directly @@ -38,6 +40,7 @@ * corrupt the database. Of course if your application code is known to * be bug-free (...) then this is not an issue. * + * @section caveats_sec Caveats * Troubleshooting the lock file, plus semaphores on BSD systems: * * - A broken lockfile can cause sync issues. @@ -107,7 +110,7 @@ * top-level directory of the distribution or, alternatively, at * . * - * @par Derived From: + * @par Derived From: * This code is derived from btree.c written by Martin Hedenfalk. * * Copyright (c) 2009, 2010 Martin Hedenfalk @@ -133,8 +136,9 @@ extern "C" { #endif -/** @defgroup public Public API +/** @defgroup mdb MDB API * @{ + * @brief OpenLDAP Memory-Mapped Database Manager */ /** @defgroup Version Version Macros * @{