Enhance CursorIterator JavaDocs when using integer keys (#105)

benalexau · benalexau · commit 6cec06ca83b7 · 2018-12-19T12:16:49.000+11:00
diff --git a/src/main/java/org/lmdbjava/CursorIterator.java b/src/main/java/org/lmdbjava/CursorIterator.java
@@ -39,6 +39,12 @@
  * <p>
  * An instance will create and close its own cursor.
  *
+ * <p>
+ * If iterating over keys stored with {@link DbiFlags#MDB_INTEGERKEY} you must
+ * provide a Java iterator when constructing the {@link Dbi} or this class. It
+ * is more efficient to use an iterator only with this class, as this avoids
+ * LMDB calling back into Java code to perform the integer key comparison.
+ *
  * @param <T> buffer type
  */
 public final class CursorIterator<T> implements
