From 9828b6d5fd380f4a44a8ce157794f75b95c685aa Mon Sep 17 00:00:00 2001
From: Jermy Li <javaloveme@gmail.com>
Date: Thu, 16 Dec 2021 21:03:37 -0800
Subject: [PATCH] fix java doc issues (#9253)

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

Reviewed By: jay-zhuang

Differential Revision: D32990516

Pulled By: mrambacher

fbshipit-source-id: c7cdb6562ac6871bca6ea0d9efa454f3a902a137
---
 .../main/java/org/rocksdb/ColumnFamilyOptionsInterface.java   | 4 +++-
 java/src/main/java/org/rocksdb/EventListener.java             | 3 +++
 java/src/main/java/org/rocksdb/SstFileWriter.java             | 1 +
 java/src/main/java/org/rocksdb/WriteBatchInterface.java       | 4 ++--
 4 files changed, 9 insertions(+), 3 deletions(-)

diff --git a/java/src/main/java/org/rocksdb/ColumnFamilyOptionsInterface.java b/java/src/main/java/org/rocksdb/ColumnFamilyOptionsInterface.java
index 5767b39be..97357aacf 100644
--- a/java/src/main/java/org/rocksdb/ColumnFamilyOptionsInterface.java
+++ b/java/src/main/java/org/rocksdb/ColumnFamilyOptionsInterface.java
@@ -14,6 +14,8 @@ public interface ColumnFamilyOptionsInterface<T extends ColumnFamilyOptionsInter
    * The function recovers options to a previous version. Only 4.6 or later
    * versions are supported.
    *
+   * @param majorVersion The major version to recover default values of options
+   * @param minorVersion The minor version to recover default values of options
    * @return the instance of the current object.
    */
   T oldDefaults(int majorVersion, int minorVersion);
@@ -30,8 +32,8 @@ public interface ColumnFamilyOptionsInterface<T extends ColumnFamilyOptionsInter
    * Some functions that make it easier to optimize RocksDB
    * Use this if your DB is very small (like under 1GB) and you don't want to
    * spend lots of memory for memtables.
-   * An optional cache object is passed in to be used as the block cache
    *
+   * @param cache An optional cache object is passed in to be used as the block cache
    * @return the instance of the current object.
    */
   T optimizeForSmallDb(Cache cache);
diff --git a/java/src/main/java/org/rocksdb/EventListener.java b/java/src/main/java/org/rocksdb/EventListener.java
index 808278d02..f20a258bd 100644
--- a/java/src/main/java/org/rocksdb/EventListener.java
+++ b/java/src/main/java/org/rocksdb/EventListener.java
@@ -303,6 +303,8 @@ public interface EventListener {
    * false, then they won't be called.
    *
    * Default: false
+   *
+   * @return whether to callback when file read/write is finished
    */
   boolean shouldBeNotifiedOnFileIO();
 
@@ -316,6 +318,7 @@ public interface EventListener {
    *
    * @param backgroundErrorReason background error reason code
    * @param backgroundError background error codes
+   * @return whether to suppress the automatic recovery
    */
   boolean onErrorRecoveryBegin(
       final BackgroundErrorReason backgroundErrorReason, final Status backgroundError);
diff --git a/java/src/main/java/org/rocksdb/SstFileWriter.java b/java/src/main/java/org/rocksdb/SstFileWriter.java
index 6d9c559bf..c65479f83 100644
--- a/java/src/main/java/org/rocksdb/SstFileWriter.java
+++ b/java/src/main/java/org/rocksdb/SstFileWriter.java
@@ -244,6 +244,7 @@ public class SstFileWriter extends RocksObject {
   /**
    * Return the current file size.
    *
+   * @return the current file size.
    * @throws RocksDBException thrown if error happens in underlying
    *    native library.
    */
diff --git a/java/src/main/java/org/rocksdb/WriteBatchInterface.java b/java/src/main/java/org/rocksdb/WriteBatchInterface.java
index a755066d9..c4ac6eead 100644
--- a/java/src/main/java/org/rocksdb/WriteBatchInterface.java
+++ b/java/src/main/java/org/rocksdb/WriteBatchInterface.java
@@ -50,7 +50,7 @@ public interface WriteBatchInterface {
      *     Supports direct buffer only.
      * @param value the value associated with the specified key. It is using position and limit.
      *     Supports direct buffer only.
-     * @throws RocksDBException
+     * @throws RocksDBException thrown if error happens in underlying native library.
      */
     void put(final ByteBuffer key, final ByteBuffer value) throws RocksDBException;
 
@@ -64,7 +64,7 @@ public interface WriteBatchInterface {
      *     Supports direct buffer only.
      * @param value the value associated with the specified key. It is using position and limit.
      *     Supports direct buffer only.
-     * @throws RocksDBException
+     * @throws RocksDBException thrown if error happens in underlying native library.
      */
     void put(ColumnFamilyHandle columnFamilyHandle, final ByteBuffer key, final ByteBuffer value)
         throws RocksDBException;