Additional JavaDocs related to #195

benalexau · benalexau · commit 9f821c0eaa33 · 2023-02-03T11:50:50.000+11:00
diff --git a/src/main/java/org/lmdbjava/Env.java b/src/main/java/org/lmdbjava/Env.java
@@ -285,10 +285,7 @@ public Dbi<T> openDbi(final String name, final Comparator<T> comparator,
   }
 
   /**
-   * Open the {@link Dbi}.
-   *
-   * <p>
-   * This method must not be called from concurrent threads.
+   * Convenience method that opens a {@link Dbi} with a UTF-8 database name.
    *
    * @param name  name of the database (or null if no name is required)
    * @param flags to open the database with
@@ -315,6 +312,10 @@ public Dbi<T> openDbi(final byte[] name, final DbiFlags... flags) {
    * comparator is typically more efficient (as there is no need for the native
    * library to call back into Java for the comparator result).
    *
+   * <p>
+   * This method (and its overloaded convenience variants) must not be called
+   * from concurrent threads.
+   *
    * @param name       name of the database (or null if no name is required)
    * @param comparator custom comparator callback (or null to use LMDB default)
    * @param flags      to open the database with
