Edit and cleanup Javadoc.

Resolves #2586

Author: jxblum

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

@@ -38,17 +38,19 @@
 import org.springframework.util.ReflectionUtils;
 
 /**
- * {@link org.springframework.cache.Cache} implementation using for Redis as underlying store.
+ * {@link org.springframework.cache.Cache} implementation using for Redis as the underlying store for cache data.
  * <p>
  * Use {@link RedisCacheManager} to create {@link RedisCache} instances.
  *
  * @author Christoph Strobl
  * @author Mark Paluch
  * @author Piotr Mionskowski
+ * @author John Blum
  * @see RedisCacheConfiguration
  * @see RedisCacheWriter
  * @since 2.0
  */
+@SuppressWarnings("unused")
 public class RedisCache extends AbstractValueAdaptingCache {
 
 	private static final byte[] BINARY_NULL_VALUE = RedisSerializer.java().serialize(NullValue.INSTANCE);
@@ -130,6 +132,7 @@ public <T> T get(Object key, Callable<T> valueLoader) {
 		return getSynchronized(key, valueLoader);
 	}
 
+	@Nullable
 	@SuppressWarnings("unchecked")
 	private synchronized <T> T getSynchronized(Object key, Callable<T> valueLoader) {
 
@@ -396,5 +399,4 @@ private String prefixCacheKey(String key) {
 		// allow contextual cache names by computing the key prefix on every call.
 		return cacheConfig.getKeyPrefixFor(name) + key;
 	}
-
 }

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

@@ -32,13 +32,15 @@
 import org.springframework.util.Assert;
 
 /**
- * Immutable {@link RedisCacheConfiguration} helps customizing {@link RedisCache} behaviour such as caching
- * {@literal null} values, cache key prefixes and binary serialization. <br />
- * Start with {@link RedisCacheConfiguration#defaultCacheConfig()} and customize {@link RedisCache} behaviour from there
- * on.
+ * Immutable {@link RedisCacheConfiguration} used to customize {@link RedisCache} behaviour, such as caching
+ * {@literal null} values, computing cache key prefixes and handling binary serialization.
+ * <p>
+ * Start with {@link RedisCacheConfiguration#defaultCacheConfig()} and customize {@link RedisCache} behaviour
+ * from that point on.
  *
  * @author Christoph Strobl
  * @author Mark Paluch
+ * @author John Blum
  * @since 2.0
  */
 public class RedisCacheConfiguration {
@@ -358,7 +360,10 @@ public void configureKeyConverters(Consumer<ConverterRegistry> registryConsumer)
 	}
 
 	/**
-	 * Registers default cache key converters. The following converters get registered:
+	 * Registers default cache {@link Converter key converters}.
+	 * <p>
+	 * The following converters get registered:
+	 * <p>
 	 * <ul>
 	 * <li>{@link String} to {@link byte byte[]} using UTF-8 encoding.</li>
 	 * <li>{@link SimpleKey} to {@link String}</li>

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

@@ -18,7 +18,7 @@
 import org.springframework.lang.Nullable;
 
 /**
- * Interface for the commands supported by Redis.
+ * Interface defining the commands supported by Redis.
  *
  * @author Costin Leau
  * @author Christoph Strobl
@@ -29,14 +29,16 @@ public interface RedisCommands extends RedisKeyCommands, RedisStringCommands, Re
 		RedisServerCommands, RedisStreamCommands, RedisScriptingCommands, RedisGeoCommands, RedisHyperLogLogCommands {
 
 	/**
-	 * 'Native' or 'raw' execution of the given command along-side the given arguments. The command is executed as is,
-	 * with as little 'interpretation' as possible - it is up to the caller to take care of any processing of arguments or
-	 * the result.
+	 * {@literal Native} or {@literal raw} execution of the given Redis command along with the given arguments.
+	 * <p>
+	 * The command is executed as is, with as little interpretation as possible - it is up to the caller to take care
+	 * of any processing of arguments or the result.
 	 *
-	 * @param command Command to execute. must not be {@literal null}.
-	 * @param args Possible command arguments (may be empty).
-	 * @return execution result. Can be {@literal null}.
+	 * @param command Redis {@link String command} to execute; must not be {@literal null}.
+	 * @param args optional array of command arguments; may be empty;
+	 * @return the execution result; may be {@literal null}.
 	 */
 	@Nullable
 	Object execute(String command, byte[]... args);
+
 }

src/main/java/org/springframework/data/redis/core/RedisCallback.java

@@ -25,17 +25,22 @@
  * {@code get/set/trim etc...}.
  *
  * @author Costin Leau
+ * @author John Blum
  */
 public interface RedisCallback<T> {
 
 	/**
-	 * Gets called by {@link RedisTemplate} with an active Redis connection. Does not need to care about activating or
-	 * closing the connection or handling exceptions.
+	 * Method called by {@link RedisTemplate} with an active {@link RedisConnection}.
+	 * <p>
+	 * Callback code need not care about activating/opening or closing the {@link RedisConnection},
+	 * nor handling {@link Exception exceptions}.
 	 *
-	 * @param connection active Redis connection
-	 * @return a result object or {@code null} if none
-	 * @throws DataAccessException
+	 * @param connection active {@link RedisConnection Redis connection}.
+	 * @return the {@link Object result} of the operation performed in the callback or {@code null}.
+	 * @throws DataAccessException if the operation performed by the callback fails to execute in the context of Redis
+	 * using the given {@link RedisConnection}.
 	 */
 	@Nullable
 	T doInRedis(RedisConnection connection) throws DataAccessException;
+
 }