]> git.sur5r.net Git - openldap/commitdiff
Doc layout tweaks
authorHoward Chu <hyc@symas.com>
Wed, 28 Nov 2012 23:34:19 +0000 (15:34 -0800)
committerHoward Chu <hyc@symas.com>
Wed, 28 Nov 2012 23:34:19 +0000 (15:34 -0800)
libraries/libmdb/mdb.h

index 332003462d4005dd1ce60a3cf270e3c961ea20ea..784c5ee0ad9052b7001e192e5e3bce6e6db4fcae 100644 (file)
@@ -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.
  * top-level directory of the distribution or, alternatively, at
  * <http://www.OpenLDAP.org/license.html>.
  *
- *     @par Derived From:
+ *     @par Derived From:
  * This code is derived from btree.c written by Martin Hedenfalk.
  *
  * Copyright (c) 2009, 2010 Martin Hedenfalk <martin@bzero.se>
 extern "C" {
 #endif
 
-/** @defgroup public Public API
+/** @defgroup mdb MDB API
  *     @{
+ *     @brief OpenLDAP Memory-Mapped Database Manager
  */
 /** @defgroup Version Version Macros
  *     @{