From 74dc77afa4b90db51e5c2163d870ffcf23084bbc Mon Sep 17 00:00:00 2001
From: Nikita Koksharov <nkoksharov@redisson.pro>
Date: Wed, 31 Jul 2024 11:21:58 +0300
Subject: [PATCH] javadocs fixed

---
 redisson/src/main/java/org/redisson/api/RSearch.java         | 4 +++-
 redisson/src/main/java/org/redisson/api/RSearchAsync.java    | 4 +++-
 redisson/src/main/java/org/redisson/api/RSearchReactive.java | 4 +++-
 redisson/src/main/java/org/redisson/api/RSearchRx.java       | 4 +++-
 4 files changed, 12 insertions(+), 4 deletions(-)

diff --git a/redisson/src/main/java/org/redisson/api/RSearch.java b/redisson/src/main/java/org/redisson/api/RSearch.java
index 7a428fd56..ba7a0fe26 100644
--- a/redisson/src/main/java/org/redisson/api/RSearch.java
+++ b/redisson/src/main/java/org/redisson/api/RSearch.java
@@ -211,6 +211,8 @@ public interface RSearch extends RSearchAsync {
 
     /**
      * Executes spell checking by defined index name and query.
+     * Returns a map of misspelled terms and their score.
+     *
      * <pre>
      * Map<String, Map<String, Double>> res = s.spellcheck("idx", "Hocke sti", SpellcheckOptions.defaults()
      *                                                                                          .includedTerms("name"));
@@ -219,7 +221,7 @@ public interface RSearch extends RSearchAsync {
      * @param indexName index name
      * @param query query
      * @param options spell checking options
-     * @return result
+     * @return map of misspelled terms and their score
      */
     Map<String, Map<String, Double>> spellcheck(String indexName, String query, SpellcheckOptions options);
 
diff --git a/redisson/src/main/java/org/redisson/api/RSearchAsync.java b/redisson/src/main/java/org/redisson/api/RSearchAsync.java
index 12f0f7446..9f191c269 100644
--- a/redisson/src/main/java/org/redisson/api/RSearchAsync.java
+++ b/redisson/src/main/java/org/redisson/api/RSearchAsync.java
@@ -211,6 +211,8 @@ public interface RSearchAsync {
 
     /**
      * Executes spell checking by defined index name and query.
+     * Returns a map of misspelled terms and their score.
+     *
      * <pre>
      * Map<String, Map<String, Double>> res = s.spellcheck("idx", "Hocke sti", SpellcheckOptions.defaults()
      *                                                                                          .includedTerms("name"));
@@ -219,7 +221,7 @@ public interface RSearchAsync {
      * @param indexName index name
      * @param query query
      * @param options spell checking options
-     * @return result
+     * @return map of misspelled terms and their score
      */
     RFuture<Map<String, Map<String, Double>>> spellcheckAsync(String indexName, String query, SpellcheckOptions options);
 
diff --git a/redisson/src/main/java/org/redisson/api/RSearchReactive.java b/redisson/src/main/java/org/redisson/api/RSearchReactive.java
index 62a6cd9a1..ea05601c5 100644
--- a/redisson/src/main/java/org/redisson/api/RSearchReactive.java
+++ b/redisson/src/main/java/org/redisson/api/RSearchReactive.java
@@ -212,6 +212,8 @@ public interface RSearchReactive {
 
     /**
      * Executes spell checking by defined index name and query.
+     * Returns a map of misspelled terms and their score.
+     *
      * <pre>
      * Map<String, Map<String, Double>> res = s.spellcheck("idx", "Hocke sti", SpellcheckOptions.defaults()
      *                                                                                          .includedTerms("name"));
@@ -220,7 +222,7 @@ public interface RSearchReactive {
      * @param indexName index name
      * @param query query
      * @param options spell checking options
-     * @return result
+     * @return map of misspelled terms and their score
      */
     Mono<Map<String, Map<String, Double>>> spellcheck(String indexName, String query, SpellcheckOptions options);
 
diff --git a/redisson/src/main/java/org/redisson/api/RSearchRx.java b/redisson/src/main/java/org/redisson/api/RSearchRx.java
index cb445f77b..9d14c58fb 100644
--- a/redisson/src/main/java/org/redisson/api/RSearchRx.java
+++ b/redisson/src/main/java/org/redisson/api/RSearchRx.java
@@ -214,6 +214,8 @@ public interface RSearchRx {
 
     /**
      * Executes spell checking by defined index name and query.
+     * Returns a map of misspelled terms and their score.
+     *
      * <pre>
      * Map<String, Map<String, Double>> res = s.spellcheck("idx", "Hocke sti", SpellcheckOptions.defaults()
      *                                                                                          .includedTerms("name"));
@@ -222,7 +224,7 @@ public interface RSearchRx {
      * @param indexName index name
      * @param query     query
      * @param options   spell checking options
-     * @return result
+     * @return map of misspelled terms and their score
      */
     Single<Map<String, Map<String, Double>>> spellcheck(String indexName, String query, SpellcheckOptions options);