Skip to content

Commit 8598275

Browse files
authored
Fix JavaDoc warnings (#3990)
1 parent d51969e commit 8598275

File tree

6 files changed

+26
-19
lines changed

6 files changed

+26
-19
lines changed

src/main/java/redis/clients/jedis/CommandObjects.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2006,7 +2006,7 @@ public final CommandObject<List<Tuple>> zdiffWithScores(byte[]... keys) {
20062006
}
20072007

20082008
/**
2009-
* @deprecated Use {@link #zdiffstore(byte..., byte[]...)}.
2009+
* @deprecated Use {@link #zdiffstore(byte[], byte[][])}.
20102010
*/
20112011
@Deprecated
20122012
public final CommandObject<Long> zdiffStore(byte[] dstkey, byte[]... keys) {

src/main/java/redis/clients/jedis/DefaultJedisClientConfig.java

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -175,7 +175,8 @@ public DefaultJedisClientConfig build() {
175175
}
176176

177177
/**
178-
* Shortcut to {@link Builder#protocol(redis.clients.jedis.RedisProtocol)} with {@link RedisProtocol#RESP3}.
178+
* Shortcut to {@link redis.clients.jedis.DefaultJedisClientConfig.Builder#protocol(RedisProtocol)} with
179+
* {@link RedisProtocol#RESP3}.
179180
*/
180181
public Builder resp3() {
181182
return protocol(RedisProtocol.RESP3);

src/main/java/redis/clients/jedis/JedisCluster.java

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -30,17 +30,21 @@ public class JedisCluster extends UnifiedJedis {
3030
public static final int DEFAULT_MAX_ATTEMPTS = 5;
3131

3232
/**
33-
* Creates a JedisCluster instance. The provided node is used to make the first contact with the cluster.<br>
34-
* Here, the default timeout of {@value JedisCluster#DEFAULT_TIMEOUT} ms is being used with {@value JedisCluster#DEFAULT_MAX_ATTEMPTS} maximum attempts.
33+
* Creates a JedisCluster instance. The provided node is used to make the first contact with the cluster.
34+
* <p>
35+
* Here, the default timeout of {@value redis.clients.jedis.JedisCluster#DEFAULT_TIMEOUT} ms is being used with
36+
* {@value redis.clients.jedis.JedisCluster#DEFAULT_MAX_ATTEMPTS} maximum attempts.
3537
* @param node Node to first connect to.
3638
*/
3739
public JedisCluster(HostAndPort node) {
3840
this(Collections.singleton(node));
3941
}
4042

4143
/**
42-
* Creates a JedisCluster instance. The provided node is used to make the first contact with the cluster.<br>
43-
* Here, the default timeout of {@value JedisCluster#DEFAULT_TIMEOUT} ms is being used with {@value JedisCluster#DEFAULT_MAX_ATTEMPTS} maximum attempts.
44+
* Creates a JedisCluster instance. The provided node is used to make the first contact with the cluster.
45+
* <p>
46+
* Here, the default timeout of {@value redis.clients.jedis.JedisCluster#DEFAULT_TIMEOUT} ms is being used with
47+
* {@value redis.clients.jedis.JedisCluster#DEFAULT_MAX_ATTEMPTS} maximum attempts.
4448
* @param node Node to first connect to.
4549
* @param timeout connection and socket timeout in milliseconds.
4650
*/
@@ -117,7 +121,9 @@ public JedisCluster(HostAndPort node, final JedisClientConfig clientConfig, int
117121

118122
/**
119123
* Creates a JedisCluster with multiple entry points.
120-
* Here, the default timeout of {@value JedisCluster#DEFAULT_TIMEOUT} ms is being used with {@value JedisCluster#DEFAULT_MAX_ATTEMPTS} maximum attempts.
124+
* <p>
125+
* Here, the default timeout of {@value redis.clients.jedis.JedisCluster#DEFAULT_TIMEOUT} ms is being used with
126+
* {@value redis.clients.jedis.JedisCluster#DEFAULT_MAX_ATTEMPTS} maximum attempts.
121127
* @param nodes Nodes to connect to.
122128
*/
123129
public JedisCluster(Set<HostAndPort> nodes) {
@@ -126,7 +132,9 @@ public JedisCluster(Set<HostAndPort> nodes) {
126132

127133
/**
128134
* Creates a JedisCluster with multiple entry points.
129-
* Here, the default timeout of {@value JedisCluster#DEFAULT_TIMEOUT} ms is being used with {@value JedisCluster#DEFAULT_MAX_ATTEMPTS} maximum attempts.
135+
* <p>
136+
* Here, the default timeout of {@value redis.clients.jedis.JedisCluster#DEFAULT_TIMEOUT} ms is being used with
137+
* {@value redis.clients.jedis.JedisCluster#DEFAULT_MAX_ATTEMPTS} maximum attempts.
130138
* @param nodes Nodes to connect to.
131139
* @param timeout connection and socket timeout in milliseconds.
132140
*/

src/main/java/redis/clients/jedis/commands/FunctionBinaryCommands.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ public interface FunctionBinaryCommands {
1414
* @param name
1515
* @param keys
1616
* @param args
17-
* @return
17+
* @return value depends on the function that was executed
1818
*/
1919
Object fcall(byte[] name, List<byte[]> keys, List<byte[]> args);
2020

src/main/java/redis/clients/jedis/commands/SortedSetBinaryCommands.java

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@
22

33
import java.util.List;
44
import java.util.Map;
5-
import java.util.Set;
65

76
import redis.clients.jedis.args.SortedSetOption;
87
import redis.clients.jedis.params.*;
@@ -139,7 +138,7 @@ default ScanResult<Tuple> zscan(byte[] key, byte[] cursor) {
139138
List<Tuple> zdiffWithScores(byte[]... keys);
140139

141140
/**
142-
* @deprecated Use {@link #zdiffstore(byte..., byte[]...)}.
141+
* @deprecated Use {@link #zdiffstore(byte[], byte[][])}.
143142
*/
144143
@Deprecated
145144
long zdiffStore(byte[] dstkey, byte[]... keys);
@@ -155,24 +154,24 @@ default ScanResult<Tuple> zscan(byte[] key, byte[] cursor) {
155154
long zinterstore(byte[] dstkey, ZParams params, byte[]... sets);
156155

157156
/**
158-
* Similar to {@link SortedSetBinaryCommands#zinter(ZParams, byte[]...) ZINTER}, but
159-
* instead of returning the result set, it returns just the cardinality of the result.
157+
* Similar to {@link #zinter(ZParams, byte[][]) ZINTER}, but instead of returning the result set,
158+
* it returns just the cardinality of the result.
160159
* <p>
161160
* Time complexity O(N*K) worst case with N being the smallest input sorted set, K
162161
* being the number of input sorted sets
163-
* @see SortedSetBinaryCommands#zinter(ZParams, byte[]...)
162+
* @see #zinter(ZParams, byte[][])
164163
* @param keys group of sets
165164
* @return The number of elements in the resulting intersection
166165
*/
167166
long zintercard(byte[]... keys);
168167

169168
/**
170-
* Similar to {@link SortedSetBinaryCommands#zinter(ZParams, byte[]...) ZINTER}, but
171-
* instead of returning the result set, it returns just the cardinality of the result.
169+
* Similar to {@link #zinter(ZParams, byte[][]) ZINTER}, but instead of returning the result set,
170+
* it returns just the cardinality of the result.
172171
* <p>
173172
* Time complexity O(N*K) worst case with N being the smallest input sorted set, K
174173
* being the number of input sorted sets
175-
* @see SortedSetBinaryCommands#zinter(ZParams, byte[]...)
174+
* @see #zinter(ZParams, byte[][])
176175
* @param limit If the intersection cardinality reaches limit partway through the computation,
177176
* the algorithm will exit and yield limit as the cardinality
178177
* @param keys group of sets

src/main/java/redis/clients/jedis/commands/SortedSetPipelineBinaryCommands.java

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@
22

33
import java.util.List;
44
import java.util.Map;
5-
import java.util.Set;
65

76
import redis.clients.jedis.Response;
87
import redis.clients.jedis.args.SortedSetOption;
@@ -140,7 +139,7 @@ default Response<ScanResult<Tuple>> zscan(byte[] key, byte[] cursor) {
140139
Response<List<Tuple>> zdiffWithScores(byte[]... keys);
141140

142141
/**
143-
* @deprecated Use {@link #zdiffstore(byte..., byte[]...)}.
142+
* @deprecated Use {@link #zdiffstore(byte[], byte[][])}.
144143
*/
145144
@Deprecated
146145
Response<Long> zdiffStore(byte[] dstkey, byte[]... keys);

0 commit comments

Comments
 (0)