address jdoc warnings (#161)

RediSearch · Jul 29, 2021 · 2e54b92 · 2e54b92
1 parent b42690d
commit 2e54b92
Show file tree

Hide file tree

Showing 4 changed files with 15 additions and 17 deletions.
diff --git a/src/main/java/io/redisearch/Client.java b/src/main/java/io/redisearch/Client.java
@@ -366,45 +366,45 @@ public interface Client extends Closeable{
      *
      * @param option the name of the configuration option
      * @param value a value for the configuration option
-     * @return
+     * @return OK
      */
     boolean setConfig(ConfigOption option, String value);
 
     /**
      * Get runtime configuration option value
      *
      * @param option the name of the configuration option
-     * @return
+     * @return config
      */
     String getConfig(ConfigOption option);
 
     /**
      * Get all configuration options, consisting of the option's name and current value
      *
-     * @return
+     * @return all configs map
      */
     Map<String, String> getAllConfig();
 
     /**
      * Add an alias to the index.
      * @param name
-     * @return
+     * @return OK
      */
     boolean addAlias(String name);
 
     /**
      * Update an alias from an index.
      *
      * @param name
-     * @return
+     * @return OK
      */
     boolean updateAlias(String name);
 
     /**
      * remove an alias from an index.
      *
      * @param name
-     * @return
+     * @return OK
      */
     boolean deleteAlias(String name);
 
@@ -414,7 +414,7 @@ public interface Client extends Closeable{
      * @param terms
      * 
      * @return the synonym group id
-     * @deprecated not supported since RediSeach 2 use {@link #updateSynonym(String, String...) instead
+     * @deprecated not supported since RediSeach 2 use {@link Client#updateSynonym(String, String...)} instead
      */
     @Deprecated
     long addSynonym(String ...terms);
@@ -426,7 +426,7 @@ public interface Client extends Closeable{
      * @param terms
      * 
      * @return true on success
-     * @deprecated use {@link #updateSynonym(String, String...) instead
+     * @deprecated use {@link Client#updateSynonym(String, String...)} instead
      */
     @Deprecated
     boolean updateSynonym(long synonymGroupId, String ...terms);

diff --git a/src/main/java/io/redisearch/Query.java b/src/main/java/io/redisearch/Query.java
@@ -397,11 +397,10 @@ public Query setWithPayload() {
 
     /**
      * Set the query language, for stemming purposes
+     * <p>See http://redisearch.io for documentation on languages and stemming
      * @param language a language. 
      * 
      * @return the query object itself
-     * 
-     * @see http://redisearch.io for documentation on languages and stemming
      */
     public Query setLanguage(String language) {
         this._language = language;
@@ -410,11 +409,10 @@ public Query setLanguage(String language) {
 
     /**
      * Set the query custom scorer
+     * <p>See http://redisearch.io for documentation on extending RediSearch
      * @param scorer a custom scorer. 
      * 
      * @return the query object itself
-     * 
-     * @see http://redisearch.io for documentation on extending RediSearch
      */
     public Query setScorer(String scorer) {
         this._scorer = scorer;

diff --git a/src/main/java/io/redisearch/aggregation/reducers/Reducers.java b/src/main/java/io/redisearch/aggregation/reducers/Reducers.java
@@ -73,7 +73,7 @@ protected List<String> getOwnArgs() {
      * REDUCE FIRST_VALUE {nargs} {property} [BY {property} [ASC|DESC]]
      * @param field
      * @param sortBy
-     * @return
+     * @return Reducer
      */
     public static Reducer first_value(String field, SortedField sortBy) {
         return new Reducer(field) {

diff --git a/src/main/java/io/redisearch/client/Client.java b/src/main/java/io/redisearch/client/Client.java
@@ -238,7 +238,7 @@ public boolean alterIndex(Schema.Field ...fields) {
      *
      * @param option the name of the configuration option
      * @param value a value for the configuration option
-     * @return
+     * @return OK
      */
     @Override
     public boolean setConfig(ConfigOption option, String value) {
@@ -254,7 +254,7 @@ public boolean setConfig(ConfigOption option, String value) {
      * Get runtime configuration option value
      *
      * @param option the name of the configuration option
-     * @return
+     * @return config
      */
     @Override
     public String getConfig(ConfigOption option) {
@@ -275,7 +275,7 @@ public String getConfig(ConfigOption option) {
     /**
      * Get all configuration options, consisting of the option's name and current value
      *
-     * @return
+     * @return all configs map
      */
     @Override
     public Map<String, String> getAllConfig() {
@@ -1171,7 +1171,7 @@ public IndexOptions SetNoStopwords() {
         /**
          * Temporary
          * @param expire
-         * @return
+         * @return IndexOptions
          */
         public IndexOptions setTemporary(long expire) {
           this.expire = expire;