ISAR/libmdbx
3
0
Fork 0
mirror of https://github.com/isar/libmdbx.git synced 2025-03-04 05:08:14 +08:00
Code Issues Packages Projects Releases Wiki Activity

mdbx-doc: fix typo and add refs to c_crud_hints anchor.

Browse Source 
Change-Id: I46b26ee6f9ca4e1f06c573b61a42d8fbedefd836
This commit is contained in:
Leonid Yuriev 2021-01-26 20:14:21 +03:00
parent 943bb552a2
commit 7ae5ddefe5
1 changed files with 15 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
mdbx.h
View File

@ -1380,7 +1380,7 @@ DEFINE_ENUM_FLAG_OPERATORS(MDBX_db_flags_t)
/** \brief Data changing flags /** \brief Data changing flags
* \ingroup c_crud * \ingroup c_crud
* \see c_crud_hint * \see \ref c_crud_hints "Quick reference for Insert/Update/Delete operations"
* \see mdbx_put() \see mdbx_cursor_put() \see mdbx_replace() */ * \see mdbx_put() \see mdbx_cursor_put() \see mdbx_replace() */
enum MDBX_put_flags_t { enum MDBX_put_flags_t {
/** Upsertion by default (without any other flags) */ /** Upsertion by default (without any other flags) */
@ -3823,6 +3823,8 @@ LIBMDBX_API int mdbx_get_equal_or_great(MDBX_txn *txn, MDBX_dbi dbi,
* the count of the number of elements actually written. The `iov_base` of * the count of the number of elements actually written. The `iov_base` of
* the second \ref MDBX_val is unused. * the second \ref MDBX_val is unused.
* *
* \see \ref c_crud_hints "Quick reference for Insert/Update/Delete operations"
*
* \returns A non-zero error value on failure and 0 on success, * \returns A non-zero error value on failure and 0 on success,
* some possible errors are: * some possible errors are:
* \retval MDBX_THREAD_MISMATCH Given transaction is not owned * \retval MDBX_THREAD_MISMATCH Given transaction is not owned
@ -3876,6 +3878,8 @@ LIBMDBX_API int mdbx_put(MDBX_txn *txn, MDBX_dbi dbi, const MDBX_val *key,
* combination for selection particular item from * combination for selection particular item from
* multi-value/duplicates. * multi-value/duplicates.
* *
* \see \ref c_crud_hints "Quick reference for Insert/Update/Delete operations"
*
* \returns A non-zero error value on failure and 0 on success. */ * \returns A non-zero error value on failure and 0 on success. */
LIBMDBX_API int mdbx_replace(MDBX_txn *txn, MDBX_dbi dbi, const MDBX_val *key, LIBMDBX_API int mdbx_replace(MDBX_txn *txn, MDBX_dbi dbi, const MDBX_val *key,
MDBX_val *new_data, MDBX_val *old_data, MDBX_val *new_data, MDBX_val *old_data,
@ -3902,6 +3906,8 @@ LIBMDBX_API int mdbx_replace_ex(MDBX_txn *txn, MDBX_dbi dbi,
* This function will return \ref MDBX_NOTFOUND if the specified key/data * This function will return \ref MDBX_NOTFOUND if the specified key/data
* pair is not in the database. * pair is not in the database.
* *
* \see \ref c_crud_hints "Quick reference for Insert/Update/Delete operations"
*
* \param [in] txn A transaction handle returned by \ref mdbx_txn_begin(). * \param [in] txn A transaction handle returned by \ref mdbx_txn_begin().
* \param [in] dbi A database handle returned by \ref mdbx_dbi_open(). * \param [in] dbi A database handle returned by \ref mdbx_dbi_open().
* \param [in] key The key to delete from the database. * \param [in] key The key to delete from the database.
@ -4185,6 +4191,8 @@ LIBMDBX_API int mdbx_cursor_get(MDBX_cursor *cursor, MDBX_val *key,
* the count of the number of elements actually written. The `iov_base` of * the count of the number of elements actually written. The `iov_base` of
* the second \ref MDBX_val is unused. * the second \ref MDBX_val is unused.
* *
* \see \ref c_crud_hints "Quick reference for Insert/Update/Delete operations"
*
* \returns A non-zero error value on failure and 0 on success, * \returns A non-zero error value on failure and 0 on success,
* some possible errors are: * some possible errors are:
* \retval MDBX_THREAD_MISMATCH Given transaction is not owned * \retval MDBX_THREAD_MISMATCH Given transaction is not owned
@ -4218,6 +4226,8 @@ LIBMDBX_API int mdbx_cursor_put(MDBX_cursor *cursor, const MDBX_val *key,
* Delete all of the data items for the current key. This flag has effect * Delete all of the data items for the current key. This flag has effect
* only for database(s) was created with \ref MDBX_DUPSORT. * only for database(s) was created with \ref MDBX_DUPSORT.
* *
* \see \ref c_crud_hints "Quick reference for Insert/Update/Delete operations"
*
* \returns A non-zero error value on failure and 0 on success, * \returns A non-zero error value on failure and 0 on success,
* some possible errors are: * some possible errors are:
* \retval MDBX_THREAD_MISMATCH Given transaction is not owned * \retval MDBX_THREAD_MISMATCH Given transaction is not owned
@ -4803,6 +4813,8 @@ typedef uint_fast64_t mdbx_attr_t;
* keys are already known to be in the correct order. Loading unsorted * keys are already known to be in the correct order. Loading unsorted
* keys with this flag will cause a \ref MDBX_KEYEXIST error. * keys with this flag will cause a \ref MDBX_KEYEXIST error.
* *
* \see \ref c_crud_hints "Quick reference for Insert/Update/Delete operations"
*
* \returns A non-zero error value on failure and 0 on success, * \returns A non-zero error value on failure and 0 on success,
* some possible errors are: * some possible errors are:
* \retval MDBX_EKEYMISMATCH * \retval MDBX_EKEYMISMATCH
@ -4850,6 +4862,8 @@ LIBMDBX_API int mdbx_cursor_put_attr(MDBX_cursor *cursor, MDBX_val *key,
* correct order. Loading unsorted keys with this flag will cause * correct order. Loading unsorted keys with this flag will cause
* a \ref MDBX_EKEYMISMATCH error. * a \ref MDBX_EKEYMISMATCH error.
* *
* \see \ref c_crud_hints "Quick reference for Insert/Update/Delete operations"
*
* \returns A non-zero error value on failure and 0 on success, * \returns A non-zero error value on failure and 0 on success,
* some possible errors are: * some possible errors are:
* \retval MDBX_KEYEXIST * \retval MDBX_KEYEXIST