mdbx-doc: документирование mdbx_cursor_on_first_dup() и mdbx_cursor_on_last_dup().

This commit is contained in:
Леонид Юрьев (Leonid Yuriev) 2024-03-22 22:29:16 +03:00
parent fb17e8877c
commit d0799fd373
2 changed files with 24 additions and 4 deletions

24
mdbx.h
View File

@ -5501,7 +5501,17 @@ mdbx_cursor_eof(const MDBX_cursor *cursor);
MDBX_NOTHROW_PURE_FUNCTION LIBMDBX_API int MDBX_NOTHROW_PURE_FUNCTION LIBMDBX_API int
mdbx_cursor_on_first(const MDBX_cursor *cursor); mdbx_cursor_on_first(const MDBX_cursor *cursor);
/** FIXME */ /** \brief Определяет стоит ли курсор на первом или единственном мульти-значении
* соответствующем ключу.
* \ingroup c_cursors
* \param [in] cursor Курсор созданный посредством \ref mdbx_cursor_open().
* \returns Значание \ref MDBX_RESULT_TRUE, либо \ref MDBX_RESULT_FALSE,
* иначе код ошибки.
* \retval MDBX_RESULT_TRUE курсор установлен на первом или единственном
* мульти-значении соответствующем ключу.
* \retval MDBX_RESULT_FALSE курсор НЕ установлен на первом или единственном
* мульти-значении соответствующем ключу.
* \retval ИНАЧЕ код ошибки. */
MDBX_NOTHROW_PURE_FUNCTION LIBMDBX_API int MDBX_NOTHROW_PURE_FUNCTION LIBMDBX_API int
mdbx_cursor_on_first_dup(const MDBX_cursor *cursor); mdbx_cursor_on_first_dup(const MDBX_cursor *cursor);
@ -5519,7 +5529,17 @@ mdbx_cursor_on_first_dup(const MDBX_cursor *cursor);
MDBX_NOTHROW_PURE_FUNCTION LIBMDBX_API int MDBX_NOTHROW_PURE_FUNCTION LIBMDBX_API int
mdbx_cursor_on_last(const MDBX_cursor *cursor); mdbx_cursor_on_last(const MDBX_cursor *cursor);
/** FIXME */ /** \brief Определяет стоит ли курсор на последнем или единственном мульти-значении
* соответствующем ключу.
* \ingroup c_cursors
* \param [in] cursor Курсор созданный посредством \ref mdbx_cursor_open().
* \returns Значание \ref MDBX_RESULT_TRUE, либо \ref MDBX_RESULT_FALSE,
* иначе код ошибки.
* \retval MDBX_RESULT_TRUE курсор установлен на последнем или единственном
* мульти-значении соответствующем ключу.
* \retval MDBX_RESULT_FALSE курсор НЕ установлен на последнем или единственном
* мульти-значении соответствующем ключу.
* \retval ИНАЧЕ код ошибки. */
MDBX_NOTHROW_PURE_FUNCTION LIBMDBX_API int MDBX_NOTHROW_PURE_FUNCTION LIBMDBX_API int
mdbx_cursor_on_last_dup(const MDBX_cursor *cursor); mdbx_cursor_on_last_dup(const MDBX_cursor *cursor);

View File

@ -25115,7 +25115,7 @@ int mdbx_cursor_on_first_dup(const MDBX_cursor *mc) {
: MDBX_EBADSIGN; : MDBX_EBADSIGN;
if (!(mc->mc_flags & C_INITIALIZED)) if (!(mc->mc_flags & C_INITIALIZED))
return mc->mc_db->md_entries ? MDBX_RESULT_FALSE : MDBX_RESULT_TRUE; return MDBX_RESULT_TRUE;
if (!mc->mc_xcursor) if (!mc->mc_xcursor)
return MDBX_RESULT_TRUE; return MDBX_RESULT_TRUE;
@ -25158,7 +25158,7 @@ int mdbx_cursor_on_last_dup(const MDBX_cursor *mc) {
: MDBX_EBADSIGN; : MDBX_EBADSIGN;
if (!(mc->mc_flags & C_INITIALIZED)) if (!(mc->mc_flags & C_INITIALIZED))
return mc->mc_db->md_entries ? MDBX_RESULT_FALSE : MDBX_RESULT_TRUE; return MDBX_RESULT_FALSE;
if (!mc->mc_xcursor) if (!mc->mc_xcursor)
return MDBX_RESULT_TRUE; return MDBX_RESULT_TRUE;