mdbx: minor fix/refix Doxygen descriptions.

This commit is contained in:
Леонид Юрьев (Leonid Yuriev) 2022-04-20 18:03:06 +03:00
parent 8ece0dfa93
commit 35b5abc103

40
mdbx.h
View File

@ -4826,26 +4826,26 @@ mdbx_get_datacmp(MDBX_db_flags_t flags);
/** \brief A callback function used to enumerate the reader lock table. /** \brief A callback function used to enumerate the reader lock table.
* \ingroup c_statinfo * \ingroup c_statinfo
* *
* \param [in] ctx An arbitrary context pointer for the callback. * \param [in] ctx An arbitrary context pointer for the callback.
* \param [in] num The serial number during enumeration, * \param [in] num The serial number during enumeration,
* starting from 1. * starting from 1.
* \param [in] slot The reader lock table slot number. * \param [in] slot The reader lock table slot number.
* \param [in] txnid The ID of the transaction being read, * \param [in] txnid The ID of the transaction being read,
* i.e. the MVCC-snapshot number. * i.e. the MVCC-snapshot number.
* \param [in] lag The lag from a recent MVCC-snapshot, * \param [in] lag The lag from a recent MVCC-snapshot,
* i.e. the number of committed write transactions * i.e. the number of committed write transactions
* since the current read transaction started. * since the current read transaction started.
* \param [in] pid The reader process ID. * \param [in] pid The reader process ID.
* \param [in] thread The reader thread ID. * \param [in] thread The reader thread ID.
* \param [in] bytes_used The number of last used page in the MVCC-snapshot * \param [in] bytes_used The number of last used page
* which being read, * in the MVCC-snapshot which being read,
* i.e. database file can't shrinked beyond this. * i.e. database file can't shrinked beyond this.
* \param [in] bytes_retired The total size of the database pages that were * \param [in] bytes_retained The total size of the database pages that were
* retired by committed write transactions after * retired by committed write transactions after
* the reader's MVCC-snapshot, * the reader's MVCC-snapshot,
* i.e. the space which would be freed after * i.e. the space which would be freed after
* the Reader releases the MVCC-snapshot * the Reader releases the MVCC-snapshot
* for reuse by completion read transaction. * for reuse by completion read transaction.
* *
* \returns < 0 on failure, >= 0 on success. \see mdbx_reader_list() */ * \returns < 0 on failure, >= 0 on success. \see mdbx_reader_list() */
typedef int(MDBX_reader_list_func)(void *ctx, int num, int slot, mdbx_pid_t pid, typedef int(MDBX_reader_list_func)(void *ctx, int num, int slot, mdbx_pid_t pid,