Fix RedisTransactionalCommands.exec(…) Javadoc #942

redis · Dec 3, 2018 · f651039 · f651039
1 parent af7ece9
commit f651039
Show file tree

Hide file tree

Showing 4 changed files with 12 additions and 4 deletions.
diff --git a/src/main/java/io/lettuce/core/api/async/RedisTransactionalAsyncCommands.java b/src/main/java/io/lettuce/core/api/async/RedisTransactionalAsyncCommands.java
@@ -41,7 +41,9 @@ public interface RedisTransactionalAsyncCommands<K, V> {
      *
      * @return List&lt;Object&gt; array-reply each element being the reply to each of the commands in the atomic transaction.
      *
-     *         When using {@code WATCH}, {@code EXEC} can return a
+     *         When using {@code WATCH}, {@code EXEC} can return a {@link TransactionResult#wasDiscarded discarded
+     *         TransactionResult}.
+     * @see TransactionResult#wasDiscarded
      */
     RedisFuture<TransactionResult> exec();
 

diff --git a/src/main/java/io/lettuce/core/api/reactive/RedisTransactionalReactiveCommands.java b/src/main/java/io/lettuce/core/api/reactive/RedisTransactionalReactiveCommands.java
@@ -41,7 +41,9 @@ public interface RedisTransactionalReactiveCommands<K, V> {
      *
      * @return Object array-reply each element being the reply to each of the commands in the atomic transaction.
      *
-     *         When using {@code WATCH}, {@code EXEC} can return a
+     *         When using {@code WATCH}, {@code EXEC} can return a {@link TransactionResult#wasDiscarded discarded
+     *         TransactionResult}.
+     * @see TransactionResult#wasDiscarded
      */
     Mono<TransactionResult> exec();
 

diff --git a/src/main/java/io/lettuce/core/api/sync/RedisTransactionalCommands.java b/src/main/java/io/lettuce/core/api/sync/RedisTransactionalCommands.java
@@ -40,7 +40,9 @@ public interface RedisTransactionalCommands<K, V> {
      *
      * @return List&lt;Object&gt; array-reply each element being the reply to each of the commands in the atomic transaction.
      *
-     *         When using {@code WATCH}, {@code EXEC} can return a
+     *         When using {@code WATCH}, {@code EXEC} can return a {@link TransactionResult#wasDiscarded discarded
+     *         TransactionResult}.
+     * @see TransactionResult#wasDiscarded
      */
     TransactionResult exec();
 

diff --git a/src/main/templates/io/lettuce/core/api/RedisTransactionalCommands.java b/src/main/templates/io/lettuce/core/api/RedisTransactionalCommands.java
@@ -40,7 +40,9 @@ public interface RedisTransactionalCommands<K, V> {
      *
      * @return List&lt;Object&gt; array-reply each element being the reply to each of the commands in the atomic transaction.
      *
-     *         When using {@code WATCH}, {@code EXEC} can return a
+     *         When using {@code WATCH}, {@code EXEC} can return a {@link TransactionResult#wasDiscarded discarded
+     *         TransactionResult}.
+     * @see TransactionResult#wasDiscarded
      */
     TransactionResult exec();