upstream/openldap
1
0
Fork 0
mirror of https://git.openldap.org/openldap/openldap.git synced 2026-06-11 01:30:05 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

ITS#9009 LMDB: doxygen updates for 1.0

Browse source
This commit is contained in:
Howard Chu 2026-05-26 20:56:18 +01:00
parent 756724e417
commit bb90ea14dc
3 changed files with 7 additions and 23 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

21
libraries/liblmdb/Doxyfile
View file

@ -31,7 +31,7 @@ PROJECT_NAME = LMDB
# This could be handy for archiving the generated documentation or
# if some version control system is used.
PROJECT_NUMBER =
PROJECT_NUMBER = 1.X
# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
# base path where the generated documentation will be put.
@ -484,12 +484,6 @@ MAX_INITIALIZER_LINES = 30
SHOW_USED_FILES = YES
# If the sources in your project are distributed over multiple directories
# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
# in the documentation. The default is NO.
SHOW_DIRECTORIES = NO
# Set the SHOW_FILES tag to NO to disable the generation of the Files page.
# This will remove the Files entry from the Quick Index and from the
# Folder Tree View (if specified). The default is YES.
@ -582,7 +576,7 @@ WARN_LOGFILE =
# directories like "/usr/src/myproject". Separate the files or directories
# with spaces.
INPUT = lmdb.h midl.h mdb.c midl.c intro.doc
INPUT = lmdb.h midl.h mdb.c midl.c module.c intro.doc
# This tag can be used to specify the character encoding of the source files
# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
@ -841,12 +835,6 @@ HTML_COLORSTYLE_GAMMA = 80
HTML_TIMESTAMP = YES
# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
# files or namespaces will be aligned in HTML using tables. If set to
# NO a bullet list will be used.
HTML_ALIGN_MEMBERS = YES
# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
# documentation will contain sections that can be hidden and shown after the
# page has loaded. For this to work a browser that supports
@ -1027,11 +1015,6 @@ ENUM_VALUES_PER_LINE = 4
GENERATE_TREEVIEW = NO
# By enabling USE_INLINE_TREES, doxygen will generate the Groups, Directories,
# and Class Hierarchy pages using a tree view instead of an ordered list.
USE_INLINE_TREES = NO
# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
# used to set the initial width (in pixels) of the frame in which the tree
# is shown.

6
libraries/liblmdb/lmdb.h
View file

@ -1238,7 +1238,7 @@ int mdb_txn_prepare(MDB_txn *txn);
* preceding #mdb_txn_commit() and this call.
* @param[in] env An environment handle returned by #mdb_env_create().
* @param[in] txnid The ID of the transaction to rollback, obtained from
* #mdb_txnid() on the previous transaction.
* #mdb_txn_id() on the previous transaction.
* @return A non-zero error value on failure and 0 on success. Some possible
* errors are:
* <ul>
@ -1910,10 +1910,10 @@ void mdb_modunload(void *handle);
* This is just a wrapper around #mdb_env_set_encrypt() to ease use of
* dynamically loaded crypto functions.
* @param[in] env An environment handle returned by #mdb_env_create()
* @param[in] funcs The crypto hooks retrieved by #mdb_modload().
* @param[in] mcf_ptr The crypto hooks retrieved by #mdb_modload().
* @param[in] passphrase The secret used to generate the encryption key for the environment.
*/
void mdb_modsetup(MDB_env *env, MDB_crypto_funcs *cf, const char *passphrase);
void mdb_modsetup(MDB_env *env, MDB_crypto_funcs *mcf_ptr, const char *passphrase);
/** @} */

3
libraries/liblmdb/module.c
View file

@ -1,4 +1,5 @@
/* module.c - helper for dynamically loading crypto module */
/** @file module.c
* @brief helper for dynamically loading crypto module */
/*
* Copyright 2020-2021 Howard Chu, Symas Corp.
* All rights reserved.