From c5f9894aec9d64b791d57e7b2bd0a387f8fe5ba3 Mon Sep 17 00:00:00 2001
From: Nikita Koksharov <nkoksharov@redisson.pro>
Date: Fri, 22 Oct 2021 09:47:29 +0300
Subject: [PATCH] javadocs fixed

---
 .../src/main/java/org/redisson/api/RReliableTopic.java | 10 ++++++----
 .../java/org/redisson/api/RReliableTopicAsync.java     |  8 +++++---
 .../java/org/redisson/api/RReliableTopicReactive.java  |  8 +++++---
 .../main/java/org/redisson/api/RReliableTopicRx.java   |  8 +++++---
 4 files changed, 21 insertions(+), 13 deletions(-)

diff --git a/redisson/src/main/java/org/redisson/api/RReliableTopic.java b/redisson/src/main/java/org/redisson/api/RReliableTopic.java
index df51755e1..9f0016599 100644
--- a/redisson/src/main/java/org/redisson/api/RReliableTopic.java
+++ b/redisson/src/main/java/org/redisson/api/RReliableTopic.java
@@ -52,6 +52,8 @@ public interface RReliableTopic extends RExpirable, RReliableTopicAsync {
      * <code>MessageListener.onMessage</code> method is called when any message
      * is published on this topic.
      * <p>
+     * Though messages broadcasted across all topic instances, listener is attached to this topic instance.
+     * <p>
      * Watchdog is started when listener was registered.
      *
      * @see org.redisson.config.Config#setReliableTopicWatchdogTimeout(long)
@@ -59,25 +61,25 @@ public interface RReliableTopic extends RExpirable, RReliableTopicAsync {
      * @param <M> - type of message
      * @param type - type of message
      * @param listener for messages
-     * @return locally unique listener id
+     * @return id of listener attached to this topic instance
      * @see MessageListener
      */
     <M> String addListener(Class<M> type, MessageListener<M> listener);
 
     /**
-     * Removes the listener by <code>id</code> for listening this topic
+     * Removes the listener by <code>id</code> attached to this topic instance
      *
      * @param listenerIds - listener ids
      */
     void removeListener(String... listenerIds);
 
     /**
-     * Removes all listeners from this topic
+     * Removes all listeners attached to this topic instance
      */
     void removeAllListeners();
 
     /**
-     * Returns amount of registered listeners to this topic
+     * Returns amount of registered listeners to this topic instance
      *
      * @return amount of listeners
      */
diff --git a/redisson/src/main/java/org/redisson/api/RReliableTopicAsync.java b/redisson/src/main/java/org/redisson/api/RReliableTopicAsync.java
index 2f3f203e3..4c6d19003 100644
--- a/redisson/src/main/java/org/redisson/api/RReliableTopicAsync.java
+++ b/redisson/src/main/java/org/redisson/api/RReliableTopicAsync.java
@@ -52,6 +52,8 @@ public interface RReliableTopicAsync extends RExpirableAsync {
      * <code>MessageListener.onMessage</code> method is called when any message
      * is published on this topic.
      * <p>
+     * Though messages broadcasted across all topic instances, listener is attached to this topic instance.
+     * <p>
      * Watchdog is started when listener was registered.
      *
      * @see org.redisson.config.Config#setReliableTopicWatchdogTimeout(long)
@@ -59,13 +61,13 @@ public interface RReliableTopicAsync extends RExpirableAsync {
      * @param <M> - type of message
      * @param type - type of message
      * @param listener for messages
-     * @return locally unique listener id
+     * @return id of listener attached to this topic instance
      * @see MessageListener
      */
     <M> RFuture<String> addListenerAsync(Class<M> type, MessageListener<M> listener);
     
     /**
-     * Removes the listener by <code>id</code> for listening this topic
+     * Removes the listener by <code>id</code> attached to this topic instance
      *
      * @param listenerIds - listener ids
      * @return void
@@ -73,7 +75,7 @@ public interface RReliableTopicAsync extends RExpirableAsync {
     RFuture<Void> removeListenerAsync(String... listenerIds);
 
     /**
-     * Removes all listeners from this topic
+     * Removes all listeners attached to this topic instance
      */
     RFuture<Void> removeAllListenersAsync();
 
diff --git a/redisson/src/main/java/org/redisson/api/RReliableTopicReactive.java b/redisson/src/main/java/org/redisson/api/RReliableTopicReactive.java
index ff5461c33..76ac83a4c 100644
--- a/redisson/src/main/java/org/redisson/api/RReliableTopicReactive.java
+++ b/redisson/src/main/java/org/redisson/api/RReliableTopicReactive.java
@@ -54,6 +54,8 @@ public interface RReliableTopicReactive extends RExpirableReactive {
      * <code>MessageListener.onMessage</code> method is called when any message
      * is published on this topic.
      * <p>
+     * Though messages broadcasted across all topic instances, listener is attached to this topic instance.
+     * <p>
      * Watchdog is started when listener was registered.
      *
      * @see org.redisson.config.Config#setReliableTopicWatchdogTimeout(long)
@@ -61,13 +63,13 @@ public interface RReliableTopicReactive extends RExpirableReactive {
      * @param <M> - type of message
      * @param type - type of message
      * @param listener for messages
-     * @return locally unique listener id
+     * @return id of listener attached to this topic instance
      * @see MessageListener
      */
     <M> Mono<String> addListener(Class<M> type, MessageListener<M> listener);
     
     /**
-     * Removes the listener by <code>id</code> for listening this topic
+     * Removes the listener by <code>id</code> attached to this topic instance
      *
      * @param listenerIds - listener ids
      * @return void
@@ -75,7 +77,7 @@ public interface RReliableTopicReactive extends RExpirableReactive {
     Mono<Void> removeListener(String... listenerIds);
 
     /**
-     * Removes all listeners from this topic
+     * Removes all listeners attached to this topic instance
      */
     Mono<Void> removeAllListeners();
 
diff --git a/redisson/src/main/java/org/redisson/api/RReliableTopicRx.java b/redisson/src/main/java/org/redisson/api/RReliableTopicRx.java
index 4716d8686..c8d0882b7 100644
--- a/redisson/src/main/java/org/redisson/api/RReliableTopicRx.java
+++ b/redisson/src/main/java/org/redisson/api/RReliableTopicRx.java
@@ -55,6 +55,8 @@ public interface RReliableTopicRx extends RExpirableRx {
      * <code>MessageListener.onMessage</code> method is called when any message
      * is published on this topic.
      * <p>
+     * Though messages broadcasted across all topic instances, listener is attached to this topic instance.
+     * <p>
      * Watchdog is started when listener was registered.
      *
      * @see org.redisson.config.Config#setReliableTopicWatchdogTimeout(long)
@@ -62,13 +64,13 @@ public interface RReliableTopicRx extends RExpirableRx {
      * @param <M> - type of message
      * @param type - type of message
      * @param listener for messages
-     * @return locally unique listener id
+     * @return id of listener attached to this topic instance
      * @see MessageListener
      */
     <M> Single<String> addListener(Class<M> type, MessageListener<M> listener);
     
     /**
-     * Removes the listener by <code>id</code> for listening this topic
+     * Removes the listener by <code>id</code> attached to this topic instance
      *
      * @param listenerIds - listener ids
      * @return void
@@ -76,7 +78,7 @@ public interface RReliableTopicRx extends RExpirableRx {
     Completable removeListener(String... listenerIds);
 
     /**
-     * Removes all listeners from this topic
+     * Removes all listeners attached to this topic instance
      */
     Completable removeAllListeners();