Minor Javadoc fixes (#9203)

Summary:
Added two missing parameter tags with description and added some descriptions for parameter / return tags

Pull Request resolved: https://github.com/facebook/rocksdb/pull/9203

Reviewed By: jay-zhuang

Differential Revision: D32990607

Pulled By: mrambacher

fbshipit-source-id: 10aea4c4cf1c28d5e97d19722ee835a965d1eb55

java/src/main/java/org/rocksdb/EventListener.java

@@ -318,7 +318,7 @@ public interface EventListener {
    *
    * @param backgroundErrorReason background error reason code
    * @param backgroundError background error codes
-   * @return whether to suppress the automatic recovery
+   * @return return {@code false} if the automatic recovery should be suppressed
    */
   boolean onErrorRecoveryBegin(
       final BackgroundErrorReason backgroundErrorReason, final Status backgroundError);

java/src/main/java/org/rocksdb/MutableColumnFamilyOptions.java

@@ -44,6 +44,7 @@ public class MutableColumnFamilyOptions
    * key1=value1;intArrayKey1=1:2:3
    *
    * @param str The string representation of the mutable column family options
+   * @param ignoreUnknown what to do if the key is not one of the keys we expect
    *
    * @return A builder for the mutable column family options
    */

java/src/main/java/org/rocksdb/MutableDBOptions.java

@@ -45,6 +45,7 @@ public class MutableDBOptions extends AbstractMutableOptions {
    * key1=value1;intArrayKey1=1:2:3
    *
    * @param str The string representation of the mutable db options
+   * @param ignoreUnknown what to do if the key is not one of the keys we expect
    *
    * @return A builder for the mutable db options
    */

java/src/main/java/org/rocksdb/RocksDB.java

@@ -3068,10 +3068,11 @@ public class RocksDB extends RocksObject {
    * That is to say that this method is probabilistic and may return false
    * positives, but never a false negative.
    *
-   * @param columnFamilyHandle
+   * @param columnFamilyHandle the {@link ColumnFamilyHandle} to look for the key in
-   * @param readOptions
+   * @param readOptions the {@link ReadOptions} to use when reading the key/value
-   * @param key
+   * @param key bytebuffer containing the value of the key
-   * @return
+   * @return false if the key definitely does not exist in the database,
+   *     otherwise true.
    */
   public boolean keyMayExist(final ColumnFamilyHandle columnFamilyHandle,
       final ReadOptions readOptions, final ByteBuffer key) {

java/src/main/java/org/rocksdb/Transaction.java

@@ -45,7 +45,7 @@ public class Transaction extends RocksObject {
 
   /**
    * If a transaction has a snapshot set, the transaction will ensure that
-   * any keys successfully written(or fetched via {@link #getForUpdate}) have
+   * any keys successfully written (or fetched via {@link #getForUpdate}) have
    * not been modified outside of this transaction since the time the snapshot
    * was set.
    *
@@ -1068,7 +1068,7 @@ public class Transaction extends RocksObject {
    * @param columnFamilyHandle The column family to delete the key/value from
    * @param key the specified key to be deleted.
    * @param assumeTracked true when it is expected that the key is already
-   *     tracked. More specifically, it means the the key was previous tracked
+   *     tracked. More specifically, it means the key was previously tracked
    *     in the same savepoint, with the same exclusive flag, and at a lower
    *     sequence number. If valid then it skips ValidateSnapshot,
    *     throws an error otherwise.
@@ -1152,7 +1152,7 @@ public class Transaction extends RocksObject {
    * @param columnFamilyHandle The column family to delete the key/value from
    * @param keyParts the specified key to be deleted.
    * @param assumeTracked true when it is expected that the key is already
-   *     tracked. More specifically, it means the the key was previous tracked
+   *     tracked. More specifically, it means the key was previously tracked
    *     in the same savepoint, with the same exclusive flag, and at a lower
    *     sequence number. If valid then it skips ValidateSnapshot,
    *     throws an error otherwise.

java/src/main/java/org/rocksdb/WriteOptions.java

@@ -171,7 +171,7 @@ public class WriteOptions extends RocksObject {
 
   /**
    * If true, this write request is of lower priority if compaction is
-   * behind. In this case that, {@link #noSlowdown()} == true, the request
+   * behind. In the case that, {@link #noSlowdown()} == true, the request
    * will be cancelled immediately with {@link Status.Code#Incomplete} returned.
    * Otherwise, it will be slowed down. The slowdown value is determined by
    * RocksDB to guarantee it introduces minimum impacts to high priority writes.