Address JDoc errors and warnings (#55)

Author: sazzad16

src/main/java/io/rebloom/client/Client.java

@@ -150,7 +150,7 @@ public boolean add(String name, byte[] value) {
    * @param name The name of the filter
    * @param options {@link io.rebloom.client.InsertOptions}
    * @param items items to add to the filter
-   * @return
+   * @return an array of booleans
    */
   public boolean[] insert(String name, InsertOptions options, String... items) {
     final List<byte[]> args = new ArrayList<>();
@@ -278,7 +278,7 @@ public boolean[] existsMulti(String name, String ...values) {
 
   /**
    * Remove the filter
-   * @param name
+   * @param name filter name
    * @return true if delete the filter, false is not delete the filter
    */
   public boolean delete(String name) {
@@ -289,8 +289,8 @@ public boolean delete(String name) {
 
   /**
    * Get information about the filter
-   * @param name
-   * @return Return information
+   * @param name filter name
+   * @return information
    */
   public Map<String, Object> info(String name) {
     try (Jedis conn = _conn()) {
@@ -302,11 +302,6 @@ public Map<String, Object> info(String name) {
    * TOPK.RESERVE key topk width depth decay
    *
    * Reserve a topk filter.
-   * @param key The key of the filter
-   * @param topk
-   * @param width
-   * @param depth
-   * @param decay
    *
    * Note that if a filter is not reserved, a new one is created when {@link #add(String, byte[])}
    * is called.
@@ -341,7 +336,7 @@ public List<String> topkAdd(String key, String ...items) {
   * Adds an item to the filter
   * @param key The key of the filter
   * @param item The item to increment
-  * @param increment
+  * @param increment The increment
   * @return item dropped from the list.
   */
  public String topkIncrBy(String key, String item, long increment) {

src/main/java/io/rebloom/client/ClusterClient.java

@@ -155,7 +155,7 @@ public Boolean execute(Jedis connection) {
      * @param name The name of the filter
      * @param options {@link io.rebloom.client.InsertOptions}
      * @param items items to add to the filter
-     * @return
+     * @return array of booleans
      */
     public boolean[] insert(String name, InsertOptions options, String... items) {
         return (new JedisClusterCommand<boolean[]>(this.connectionHandler, this.maxAttempts) {
@@ -259,7 +259,7 @@ public boolean[] execute(Jedis connection) {
 
     /**
      * Remove the filter
-     * @param name
+     * @param name Name of filter to delete
      * @return true if delete the filter, false is not delete the filter
      */
     public boolean delete(String name) {
@@ -275,7 +275,7 @@ public Boolean execute(Jedis connection) {
 
     /**
      * Get information about the filter
-     * @param name
+     * @param name Name of filter to get info
      * @return Return information
      */
     public Map<String, Object> info(String name) {
@@ -304,10 +304,6 @@ public Map<String, Object> execute(Jedis connection) {
      *
      * Reserve a topk filter.
      * @param key The key of the filter
-     * @param topk
-     * @param width
-     * @param depth
-     * @param decay
      *
      * Note that if a filter is not reserved, a new one is created when {@link #add(String, byte[])}
      * is called.
@@ -353,6 +349,7 @@ public List<String> execute(Jedis jedis) {
      * Adds an item to the filter
      * @param key The key of the filter
      * @param item The item to increment
+     * @param increment The increment
      * @return item dropped from the list.
      */
     public String topkIncrBy(String key, String item, long increment) {

src/main/java/io/rebloom/client/InsertOptions.java

@@ -16,8 +16,6 @@ public static InsertOptions insertOptions() {
   }
     /**
      * If specified, should be followed by the desired capacity for the filter to be created
-     * @param capacity
-     * @return
      */
     public InsertOptions capacity(final long capacity) {
         options.add(CAPACITY.getRaw());
@@ -27,8 +25,6 @@ public InsertOptions capacity(final long capacity) {
 
     /**
      * If specified, should be followed by the the error ratio of the newly created filter if it does not yet exist
-     * @param errorRate
-     * @return
      */
     public InsertOptions error(final double errorRate) {
         options.add(ERROR.getRaw());
@@ -39,7 +35,6 @@ public InsertOptions error(final double errorRate) {
     /**
      * If specified, indicates that the filter should not be created if it does not already exist
      * It is an error to specify NOCREATE together with either CAPACITY or ERROR .
-     * @return
      */
     public InsertOptions nocreate() {
         options.add(NOCREATE.getRaw());

src/main/java/io/rebloom/client/cf/Cuckoo.java

@@ -153,8 +153,7 @@ public interface Cuckoo {
    * proper sequence.
    *
    * @param key Name of the filter
-   * @return Returns an iterator over the Map.Entry<Long, byte[]> containing the chunks
-   *         of byte[] representing the filter
+   * @return An iterator over the Pair containing the chunks of byte[] representing the filter
    */
   Iterator<Map.Entry<Long, byte[]>> cfScanDumpIterator(String key);
 
@@ -166,8 +165,7 @@ public interface Cuckoo {
    * Returns a sequential Stream with the Map.Entry containing the Iterator and
    * Data as its source.
    *
-   * @return Returns a sequential Stream of Map.Entry<Long, byte[]> containing the Iterator and
-   *         Data
+   * @return A sequential Stream of Pair of iterator and data
    */
   Stream<Map.Entry<Long, byte[]>> cfScanDumpStream(String key);
 
@@ -176,8 +174,7 @@ public interface Cuckoo {
    * SCANDUMP command for example usage.
    *
    * @param key         Name of the filter to restore
-   * @param iterAndData a Map.Entry<Long, byte[]> containing the Iterator and
-   *                    Data.
+   * @param iterAndData Pair of iterator and data
    */
   void cfLoadChunk(String key, Map.Entry<Long, byte[]> iterAndData);