Fixed javadoc warnings (#236)

* Fixed javadoc warnings

* Spotless

Author: merlimat

client-api/src/main/java/io/oxia/client/api/AsyncOxiaClient.java

@@ -109,6 +109,7 @@ public interface AsyncOxiaClient extends AutoCloseable {
      *     the range.
      * @param endKeyExclusive The key that declares the end of the range, and is <b>excluded</b> from
      *     the range.
+     * @param options Set {@link DeleteRangeOption options} for the delete range.
      * @return A future that completes when the delete call has returned.
      */
     CompletableFuture<Void> deleteRange(
@@ -160,6 +161,7 @@ CompletableFuture<Void> deleteRange(
      *     the range.
      * @param endKeyExclusive The key that declares the end of the range, and is <b>excluded</b> from
      *     the range.
+     * @param options Set {@link ListOption options} for the list operation.
      * @return The list of keys that exist within the specified range or an empty list if there were
      *     none. Supplied via a future.
      */

client-api/src/main/java/io/oxia/client/api/EncodedAuthenticationParameterSupport.java

@@ -22,7 +22,7 @@ public interface EncodedAuthenticationParameterSupport {
      * Plugins which use ":" and/or "," in a configuration parameter value need to implement this
      * interface.
      *
-     * @param encodedAuthParamString
+     * @param encodedAuthParamString the encoded configuration parameter value
      */
     void configure(String encodedAuthParamString);
 }

client-api/src/main/java/io/oxia/client/api/SyncOxiaClient.java

@@ -101,6 +101,7 @@ PutResult put(String key, byte[] value, Set<PutOption> options)
      *     the range.
      * @param endKeyExclusive The key that declares the end of the range, and is <b>excluded</b> from
      *     the range.
+     * @param options Set {@link DeleteRangeOption options} for the delete range.
      */
     void deleteRange(
             String startKeyInclusive, String endKeyExclusive, Set<DeleteRangeOption> options);
@@ -149,6 +150,7 @@ void deleteRange(
      *     the range.
      * @param endKeyExclusive The key that declares the end of the range, and is <b>excluded</b> from
      *     the range.
+     * @param options Set {@link ListOption options} for the list operation.
      * @return The list of keys that exist within the specified range, or an empty list if there were
      *     none.
      */

client-api/src/main/java/io/oxia/client/api/exceptions/KeyAlreadyExistsException.java

@@ -19,6 +19,7 @@
 
 /** The key already exists at the server. */
 public class KeyAlreadyExistsException extends OxiaException {
+    /** The key that already exists at the server. */
     @Getter private final String key;
 
     /**

client-api/src/main/java/io/oxia/client/api/exceptions/OxiaException.java

@@ -17,10 +17,21 @@
 
 /** A super-class of exceptions describing errors that occurred on an Oxia server. */
 public abstract class OxiaException extends Exception {
+    /**
+     * Creates an instance of the exception.
+     *
+     * @param message the exception message
+     */
     OxiaException(String message) {
         super(message);
     }
 
+    /**
+     * Creates an instance of the exception.
+     *
+     * @param message the exception message
+     * @param cause the cause of the exception
+     */
     OxiaException(String message, Throwable cause) {
         super(message, cause);
     }

client-api/src/main/java/io/oxia/client/api/exceptions/UnexpectedVersionIdException.java

@@ -19,7 +19,10 @@
 
 /** The versionId at the server did not that match supplied in the call. */
 public class UnexpectedVersionIdException extends OxiaException {
+    /** The record versionId present at the server. */
     @Getter private final long version;
+
+    /** The key to which the call was scoped. */
     @Getter private final String key;
 
     /**

client-api/src/main/java/io/oxia/client/api/package-info.java

@@ -17,8 +17,6 @@
 /**
  * The public API for interacting with Oxia.
  *
- * <p>
- *
  * <pre>
  *     SyncOxiaClient client = OxiaClientBuilder.create("localhost:6648")
  *         .namespace("my-namespace")

client-api/src/main/java/io/oxia/client/internal/DefaultImplementation.java

@@ -43,6 +43,7 @@ public class DefaultImplementation {
     /**
      * Access the actual implementation of the Oxia Client API.
      *
+     * @param serviceAddress the address of the Oxia server.
      * @return the loaded implementation.
      */
     public static OxiaClientBuilder getDefaultImplementation(String serviceAddress) {