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

mdbx.h

@@ -5024,10 +5024,30 @@ LIBMDBX_API MDBX_dbi mdbx_cursor_dbi(const MDBX_cursor *cursor);
  * \returns A non-zero error value on failure and 0 on success. */
 LIBMDBX_API int mdbx_cursor_copy(const MDBX_cursor *src, MDBX_cursor *dest);
 
-/** FIXME */
+/** \brief Сравнивает позицию курсоров.
+ * \ingroup c_cursors
+ *
+ * Функция предназначена для сравнения позиций двух
+ * инициализированных/установленных курсоров, связанных с одной транзакцией и
+ * одной таблицей (DBI-дескриптором).
+ * Если же курсоры связаны с разными транзакциями, либо с разными таблицами,
+ * либо один из них не инициализирован, то результат сравнения не определен
+ * (поведением может быть изменено в последующих версиях).
+ *
+ * \param [in] left             Левый курсор для сравнения позиций.
+ * \param [in] right            Правый курсор для сравнения позиций.
+ * \param [in] ignore_multival  Булевой флаг, влияющий на результат только при
+ *        сравнении курсоров для таблиц с мульти-значениями, т.е. с флагом
+ *        \ref MDBX_DUPSORT. В случае `true`, позиции курсоров сравниваются
+ *        только по ключам, без учета позиционирования среди мульти-значений.
+ *        Иначе, в случае `false`, при совпадении позиций по ключам,
+ *        сравниваются также позиции по мульти-значениям.
+ *
+ * \retval Значение со знаком в семантике оператора `<=>` (меньше нуля, ноль,
+ * либо больше нуля) как результат сравнения позиций курсоров. */
 LIBMDBX_API int mdbx_cursor_compare(const MDBX_cursor *left,
                                     const MDBX_cursor *right,
-                                    bool ignore_nested);
+                                    bool ignore_multival);
 
 /** \brief Retrieve by cursor.
  * \ingroup c_crud