Skip to content

Commit 54feba9

Browse files
committed
Fix invalid Javadoc references.
See spring-projects#2175
1 parent 5166950 commit 54feba9

File tree

87 files changed

+164
-212
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

87 files changed

+164
-212
lines changed

src/main/java/org/springframework/data/redis/cache/BatchStrategies.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ private BatchStrategies() {
4444
* A {@link BatchStrategy} using a single {@code KEYS} and {@code DEL} command to remove all matching keys.
4545
* {@code KEYS} scans the entire keyspace of the Redis database and can block the Redis worker thread for a long time
4646
* on large keyspaces.
47-
* <p/>
47+
* <p>
4848
* {@code KEYS} is supported for standalone and clustered (sharded) Redis operation modes.
4949
*
5050
* @return batching strategy using {@code KEYS}.
@@ -56,7 +56,7 @@ public static BatchStrategy keys() {
5656
/**
5757
* A {@link BatchStrategy} using a {@code SCAN} cursors and potentially multiple {@code DEL} commands to remove all
5858
* matching keys. This strategy allows a configurable batch size to optimize for scan batching.
59-
* <p/>
59+
* <p>
6060
* Note that using the {@code SCAN} strategy might be not supported on all drivers and Redis operation modes.
6161
*
6262
* @return batching strategy using {@code SCAN}.

src/main/java/org/springframework/data/redis/cache/BatchStrategy.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,9 @@
1919

2020
/**
2121
* A {@link BatchStrategy} to be used with {@link RedisCacheWriter}.
22-
* <p/>
22+
* <p>
2323
* Mainly used to clear the cache.
24-
* <p/>
24+
* <p>
2525
* Predefined strategies using the {@link BatchStrategies#keys() KEYS} or {@link BatchStrategies#scan(int) SCAN}
2626
* commands can be found in {@link BatchStrategies}.
2727
*

src/main/java/org/springframework/data/redis/cache/RedisCache.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@
3939

4040
/**
4141
* {@link org.springframework.cache.Cache} implementation using for Redis as underlying store.
42-
* <p/>
42+
* <p>
4343
* Use {@link RedisCacheManager} to create {@link RedisCache} instances.
4444
*
4545
* @author Christoph Strobl

src/main/java/org/springframework/data/redis/cache/RedisCacheConfiguration.java

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -362,6 +362,7 @@ public void configureKeyConverters(Consumer<ConverterRegistry> registryConsumer)
362362
* <ul>
363363
* <li>{@link String} to {@link byte byte[]} using UTF-8 encoding.</li>
364364
* <li>{@link SimpleKey} to {@link String}</li>
365+
* </ul>
365366
*
366367
* @param registry must not be {@literal null}.
367368
*/

src/main/java/org/springframework/data/redis/cache/RedisCacheManager.java

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -32,10 +32,10 @@
3232

3333
/**
3434
* {@link org.springframework.cache.CacheManager} backed by a {@link RedisCache Redis} cache.
35-
* <p />
35+
* <p>
3636
* This cache manager creates caches by default upon first write. Empty caches are not visible on Redis due to how Redis
3737
* represents empty data structures.
38-
* <p />
38+
* <p>
3939
* Caches requiring a different {@link RedisCacheConfiguration} than the default configuration can be specified via
4040
* {@link RedisCacheManagerBuilder#withInitialCacheConfigurations(Map)}.
4141
*
@@ -170,7 +170,7 @@ public RedisCacheManager(RedisCacheWriter cacheWriter, RedisCacheConfiguration d
170170
* <dt>locking</dt>
171171
* <dd>disabled</dd>
172172
* <dt>batch strategy</dt>
173-
* <dd>{@link BatchStrategy#keys() KEYS}</dd>
173+
* <dd>{@link BatchStrategies#keys()}</dd>
174174
* <dt>cache configuration</dt>
175175
* <dd>{@link RedisCacheConfiguration#defaultCacheConfig()}</dd>
176176
* <dt>initial caches</dt>
@@ -423,7 +423,7 @@ public RedisCacheManagerBuilder withCacheConfiguration(String cacheName,
423423

424424
/**
425425
* Disable in-flight {@link org.springframework.cache.Cache} creation for unconfigured caches.
426-
* <p />
426+
* <p>
427427
* {@link RedisCacheManager#getMissingCache(String)} returns {@literal null} for any unconfigured
428428
* {@link org.springframework.cache.Cache} instead of a new {@link RedisCache} instance. This allows eg.
429429
* {@link org.springframework.cache.support.CompositeCacheManager} to chime in.

src/main/java/org/springframework/data/redis/connection/BitFieldSubCommands.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -113,7 +113,7 @@ protected BitFieldSubCommands set(BitFieldSet set) {
113113
}
114114

115115
/**
116-
* Obtain a new {@link BitFieldIncrByBuilder} for creating and adding a {@link BitFieldIncrby} sub command.
116+
* Obtain a new {@link BitFieldIncrByBuilder} for creating and adding a {@link BitFieldIncrBy} sub command.
117117
*
118118
* @param type must not be {@literal null}.
119119
* @return
@@ -125,7 +125,7 @@ public BitFieldIncrByBuilder incr(BitFieldType type) {
125125
/**
126126
* Create new {@link BitFieldSubCommands} adding given {@link BitFieldIncrBy} to the sub commands.
127127
*
128-
* @param get must not be {@literal null}.
128+
* @param incrBy must not be {@literal null}.
129129
* @return
130130
*/
131131
protected BitFieldSubCommands incr(BitFieldIncrBy incrBy) {

src/main/java/org/springframework/data/redis/connection/ReactiveClusterServerCommands.java

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ public interface ReactiveClusterServerCommands extends ReactiveServerCommands {
5656
* Get time unix timestamp of last successful {@link #bgSave()} operation in seconds.
5757
*
5858
* @param node must not be {@literal null}.
59-
* @return @return {@link Mono} wrapping unix timestamp.
59+
* @return {@link Mono} wrapping unix timestamp.
6060
* @throws IllegalArgumentException when {@code node} is {@literal null}.
6161
* @see RedisServerCommands#lastSave()
6262
*/
@@ -108,7 +108,6 @@ public interface ReactiveClusterServerCommands extends ReactiveServerCommands {
108108
* <li>cpu utilization</li>
109109
* <li>replication</li>
110110
* </ul>
111-
* <p>
112111
*
113112
* @param node must not be {@literal null}.
114113
* @return {@link Mono} wrapping server information.

src/main/java/org/springframework/data/redis/connection/ReactiveGeoCommands.java

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

1818
import static org.springframework.data.redis.connection.RedisGeoCommands.*;
1919

20-
import org.springframework.data.redis.domain.geo.GeoReference;
21-
import org.springframework.data.redis.domain.geo.GeoShape;
2220
import reactor.core.publisher.Flux;
2321
import reactor.core.publisher.Mono;
2422

@@ -43,6 +41,8 @@
4341
import org.springframework.data.redis.connection.ReactiveRedisConnection.MultiValueResponse;
4442
import org.springframework.data.redis.connection.ReactiveRedisConnection.NumericResponse;
4543
import org.springframework.data.redis.connection.RedisGeoCommands.GeoRadiusCommandArgs.Flag;
44+
import org.springframework.data.redis.domain.geo.GeoReference;
45+
import org.springframework.data.redis.domain.geo.GeoShape;
4646
import org.springframework.lang.Nullable;
4747
import org.springframework.util.Assert;
4848

@@ -1279,7 +1279,7 @@ public static GeoSearchCommand within(GeoShape shape) {
12791279
/**
12801280
* Sets the geoset {@literal key}. Constructs a new command instance with all previously configured properties.
12811281
*
1282-
* @param member must not be {@literal null}.
1282+
* @param reference must not be {@literal null}.
12831283
* @return a new {@link GeoSearchCommand} with {@literal key} applied.
12841284
*/
12851285
public GeoSearchCommand at(GeoReference<ByteBuffer> reference) {
@@ -1292,7 +1292,7 @@ public GeoSearchCommand at(GeoReference<ByteBuffer> reference) {
12921292
/**
12931293
* Sets the geoset {@literal key}. Constructs a new command instance with all previously configured properties.
12941294
*
1295-
* @param member must not be {@literal null}.
1295+
* @param key must not be {@literal null}.
12961296
* @return a new {@link GeoSearchCommand} with {@literal key} applied.
12971297
*/
12981298
public GeoSearchCommand in(ByteBuffer key) {
@@ -1370,7 +1370,7 @@ public static GeoSearchStoreCommand within(GeoShape shape) {
13701370
/**
13711371
* Sets the geoset {@literal key}. Constructs a new command instance with all previously configured properties.
13721372
*
1373-
* @param member must not be {@literal null}.
1373+
* @param reference must not be {@literal null}.
13741374
* @return a new {@link GeoSearchStoreCommand} with {@literal key} applied.
13751375
*/
13761376
public GeoSearchStoreCommand at(GeoReference<ByteBuffer> reference) {
@@ -1383,7 +1383,7 @@ public GeoSearchStoreCommand at(GeoReference<ByteBuffer> reference) {
13831383
/**
13841384
* Sets the geoset {@literal key}. Constructs a new command instance with all previously configured properties.
13851385
*
1386-
* @param member must not be {@literal null}.
1386+
* @param key must not be {@literal null}.
13871387
* @return a new {@link GeoSearchStoreCommand} with {@literal key} applied.
13881388
*/
13891389
public GeoSearchStoreCommand in(ByteBuffer key) {
@@ -1396,7 +1396,7 @@ public GeoSearchStoreCommand in(ByteBuffer key) {
13961396
/**
13971397
* Sets the geoset {@literal destKey}. Constructs a new command instance with all previously configured properties.
13981398
*
1399-
* @param member must not be {@literal null}.
1399+
* @param destKey must not be {@literal null}.
14001400
* @return a new {@link GeoSearchStoreCommand} with {@literal destKey} applied.
14011401
*/
14021402
public GeoSearchStoreCommand storeAt(ByteBuffer destKey) {

src/main/java/org/springframework/data/redis/connection/ReactiveKeyCommands.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@ public CopyCommand to(ByteBuffer targetKey) {
9393
/**
9494
* Applies {@code replace}. Constructs a new command instance with all previously configured properties.
9595
*
96-
* @param key must not be {@literal null}.
96+
* @param replace
9797
* @return a new {@link CopyCommand} with {@literal replace} applied.
9898
*/
9999
public CopyCommand replace(boolean replace) {

src/main/java/org/springframework/data/redis/connection/ReactiveListCommands.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -830,7 +830,7 @@ default Mono<ByteBuffer> bLMove(ByteBuffer sourceKey, ByteBuffer destinationKey,
830830
* Atomically returns and removes the first/last element (head/tail depending on the {@code from} argument) of the
831831
* list stored at {@code sourceKey}, and pushes the element at the first/last element (head/tail depending on the
832832
* {@code to} argument) of the list stored at {@code destinationKey}.
833-
* <p/>
833+
* <p>
834834
* <b>Blocks connection</b> until element available or {@code timeout} reached.
835835
*
836836
* @param commands must not be {@literal null}.

0 commit comments

Comments
 (0)