Polishing #1222

redis · Feb 11, 2020 · 1b26275 · 1b26275
1 parent 5289499
commit 1b26275
Show file tree

Hide file tree

Showing 6 changed files with 14 additions and 14 deletions.
diff --git a/src/main/java/io/lettuce/core/GeoCoordinates.java b/src/main/java/io/lettuce/core/GeoCoordinates.java
@@ -47,7 +47,7 @@ public GeoCoordinates(Number x, Number y) {
      *
      * @param x the longitude, must not be {@literal null}.
      * @param y the latitude, must not be {@literal null}.
-     * @return {@literal {@link GeoCoordinates}.
+     * @return {@link GeoCoordinates}.
      */
     public static GeoCoordinates create(Number x, Number y) {
         return new GeoCoordinates(x, y);

diff --git a/src/main/java/io/lettuce/core/RedisURI.java b/src/main/java/io/lettuce/core/RedisURI.java
@@ -68,20 +68,21 @@
  *
  * <b>Redis Standalone</b> <blockquote> <i>redis</i><b>{@code ://}</b>[<i>password@</i>]<i>host</i> [<b>{@code :} </b>
  * <i>port</i>][<b>{@code /}</b><i>database</i>][<b>{@code ?}</b> [<i>timeout=timeout</i>[<i>d|h|m|s|ms|us|ns</i>]] [
- * <i>&database=database</i>] [<i>&clientName=clientName</i>]] </blockquote>
+ * <i>&amp;database=database</i>] [<i>&amp;clientName=clientName</i>]] </blockquote>
  *
  * <b>Redis Standalone (SSL)</b> <blockquote> <i>rediss</i><b>{@code ://}</b>[<i>password@</i>]<i>host</i> [<b>{@code :} </b>
  * <i>port</i>][<b>{@code /}</b><i>database</i>][<b>{@code ?}</b> [<i>timeout=timeout</i>[<i>d|h|m|s|ms|us|ns</i>]] [
- * <i>&database=database</i>] [<i>&clientName=clientName</i>]] </blockquote>
+ * <i>&amp;database=database</i>] [<i>&amp;clientName=clientName</i>]] </blockquote>
  *
  * Redis Standalone (Unix Domain Sockets)</b> <blockquote> <i>redis-socket</i><b>{@code ://} </b>[<i>password@</i>]<i>path</i>[
- * <b>{@code ?}</b>[<i>timeout=timeout</i>[<i>d|h|m|s|ms|us|ns</i>]][<i>&database=database</i>] [<i>&clientName=clientName</i>]]
- * </blockquote>
+ * <b>{@code ?}</b>[<i>timeout=timeout</i>[<i>d|h|m|s|ms|us|ns</i>]][<i>&amp;database=database</i>]
+ * [<i>&amp;clientName=clientName</i>]] </blockquote>
  *
  * <b>Redis Sentinel</b> <blockquote> <i>redis-sentinel</i><b>{@code ://}</b>[<i>password@</i>]<i>host1</i> [<b>{@code :} </b>
  * <i>port1</i>][, <i>host2</i> [<b>{@code :}</b><i>port2</i>]][, <i>hostN</i> [<b>{@code :}</b><i>portN</i>]][<b>{@code /} </b>
  * <i>database</i>][<b>{@code ?} </b>[<i>timeout=timeout</i>[<i>d|h|m|s|ms|us|ns</i>]] [
- * <i>&sentinelMasterId=sentinelMasterId</i>] [<i>&database=database</i>] [<i>&clientName=clientName</i>]] </blockquote>
+ * <i>&amp;sentinelMasterId=sentinelMasterId</i>] [<i>&amp;database=database</i>] [<i>&amp;clientName=clientName</i>]]
+ * </blockquote>
  *
  * <p>
  * <b>Schemes</b>

diff --git a/src/main/java/io/lettuce/core/cluster/ClusterTopologyRefreshOptions.java b/src/main/java/io/lettuce/core/cluster/ClusterTopologyRefreshOptions.java
@@ -368,7 +368,7 @@ public boolean isCloseStaleConnections() {
      * to {@literal false}, only the initial seed nodes will be used as sources for topology discovery and the number of clients
      * will be obtained only for the initial seed nodes. This can be useful when using Redis Cluster with many nodes.
      *
-     * @return {@link true} if dynamic refresh sources are enabled
+     * @return {@literal true} if dynamic refresh sources are enabled
      */
     public boolean useDynamicRefreshSources() {
         return dynamicRefreshSources;

diff --git a/src/main/java/io/lettuce/core/cluster/pubsub/StatefulRedisClusterPubSubConnection.java b/src/main/java/io/lettuce/core/cluster/pubsub/StatefulRedisClusterPubSubConnection.java
@@ -37,10 +37,10 @@
  * subscription.
  *
  * <pre class="code">
- *  StatefulRedisClusterPubSubConnection<String, String> connection = clusterClient.connectPubSub();
+ *  StatefulRedisClusterPubSubConnection&lt;String, String&gt; connection = clusterClient.connectPubSub();
  *  connection.addListener(…);
  *
- *  RedisClusterPubSubCommands<String, String> sync = connection.sync();
+ *  RedisClusterPubSubCommands&lt;String, String&gt; sync = connection.sync();
  *  sync.subscribe("channel");
  *  sync.publish("channel", "message");
  * </pre>
@@ -59,10 +59,10 @@
  *
  * <pre>
  *     <code>
- *  StatefulRedisClusterPubSubConnection<String, String> connection = clusterClient.connectPubSub();
+ *  StatefulRedisClusterPubSubConnection&lt;String, String&gt; connection = clusterClient.connectPubSub();
  *  connection.addListener(…);
  *
- *  RedisClusterPubSubCommands<String, String> sync = connection.sync();
+ *  RedisClusterPubSubCommands&lt;String, String&gt; sync = connection.sync();
  *  sync.replicas().commands().psubscribe("__key*__:*");
  *     </code>
  * </pre>

diff --git a/src/main/java/io/lettuce/core/internal/Futures.java b/src/main/java/io/lettuce/core/internal/Futures.java
@@ -84,7 +84,6 @@ public static CompletableFuture<Void> from(ChannelFuture future) {
      * Adapt Netty's {@link ChannelFuture} emitting a {@link Void} result into a {@link CompletableFuture}.
      *
      * @param future
-     * @return the {@link CompletableFuture}.
      */
     public static void adapt(ChannelFuture future, CompletableFuture<Void> target) {
 

diff --git a/src/main/java/io/lettuce/core/resource/DirContextDnsResolver.java b/src/main/java/io/lettuce/core/resource/DirContextDnsResolver.java
@@ -37,7 +37,7 @@
 import io.lettuce.core.internal.LettuceAssert;
 
 /**
- * DNS Resolver based on Java's {@link com.sun.jndi.dns.DnsContextFactory}. This resolver resolves hostnames to IPv4 and IPv6
+ * DNS Resolver based on Java's {@code com.sun.jndi.dns.DnsContextFactory}. This resolver resolves hostnames to IPv4 and IPv6
  * addresses using {@code A}, {@code AAAA} and {@code CNAME} records. Java IP stack preferences are read from system properties
  * and taken into account when resolving names.
  * <p>
@@ -152,7 +152,7 @@ public void close() throws IOException {
      * Perform hostname to address resolution.
      *
      * @param host the hostname, must not be empty or {@literal null}.
-     * @return array of one or more {@link InetAddress adresses}
+     * @return array of one or more {@link InetAddress addresses}
      * @throws UnknownHostException
      */
     @Override