Java: Minor Documentation Update for Commands With Routes (valkey-io#…

…1118)

java/client/src/main/java/glide/api/commands/ConnectionManagementClusterCommands.java

@@ -44,7 +44,7 @@ public interface ConnectionManagementClusterCommands {
      *
      * @see <a href="https://redis.io/commands/ping/">redis.io</a> for details.
      * @param route Specifies the routing configuration for the command. The client will route the
-     *     command to the defined nodes.
+     *     command to the nodes defined by <code>route</code>.
      * @return <code>String</code> with <code>"PONG"</code>.
      * @example
      *     <pre>{@code
@@ -60,7 +60,7 @@ public interface ConnectionManagementClusterCommands {
      * @see <a href="https://redis.io/commands/ping/">redis.io</a> for details.
      * @param message The ping argument that will be returned.
      * @param route Specifies the routing configuration for the command. The client will route the
-     *     command to the defined nodes.
+     *     command to the nodes defined by <code>route</code>.
      * @return <code>String</code> with a copy of the argument <code>message</code>.
      * @example
      *     <pre>{@code
@@ -89,7 +89,7 @@ public interface ConnectionManagementClusterCommands {
      *
      * @see <a href="https://redis.io/commands/client-id/">redis.io</a> for details.
      * @param route Specifies the routing configuration for the command. The client will route the
-     *     command to the defined nodes.
+     *     command to the nodes defined by <code>route</code>.
      * @return A {@link ClusterValue} which holds a single value if single node route is used or a
      *     dictionary where each address is the key and its corresponding node response is the value.
      *     The value is the id of the client on that node.
@@ -124,7 +124,7 @@ public interface ConnectionManagementClusterCommands {
      *
      * @see <a href="https://redis.io/commands/client-getname/">redis.io</a> for details.
      * @param route Specifies the routing configuration for the command. The client will route the
-     *     command to the defined nodes.
+     *     command to the nodes defined by <code>route</code>.
      * @return A {@link ClusterValue} which holds a single value if single node route is used or a
      *     dictionary where each address is the key and its corresponding node response is the value.
      *     The value is the name of the client connection as a string if a name is set, or null if no

java/client/src/main/java/glide/api/commands/GenericClusterCommands.java

@@ -47,7 +47,8 @@ public interface GenericClusterCommands {
      *     <em>pub</em>/<em>sub</em> mode on <em>RESP2</em> connections) shouldn't be called using
      *     this function.
      * @param args Arguments for the custom command including the command name
-     * @param route Routing configuration for the command
+     * @param route Specifies the routing configuration for the command. The client will route the
+     *     command to the nodes defined by <code>route</code>.
      * @return Response from Redis containing an <code>Object</code>.
      * @example
      *     <pre>{@code
@@ -92,8 +93,8 @@ public interface GenericClusterCommands {
      * @see <a href="https://redis.io/topics/Transactions/">redis.io</a> for details on Redis
      *     Transactions.
      * @param transaction A {@link Transaction} object containing a list of commands to be executed.
-     * @param route Routing configuration for the transaction. The client will route the transaction
-     *     to the nodes defined by <code>route</code>.
+     * @param route Specifies the routing configuration for the transaction. The client will route the
+     *     transaction to the nodes defined by <code>route</code>.
      * @return A list of results corresponding to the execution of each command in the transaction.
      * @remarks
      *     <ul>

java/client/src/main/java/glide/api/commands/ServerManagementClusterCommands.java

@@ -34,8 +34,8 @@ public interface ServerManagementClusterCommands {
      * {@link Section#DEFAULT} option is assumed.
      *
      * @see <a href="https://redis.io/commands/info/">redis.io</a> for details.
-     * @param route Routing configuration for the command. Client will route the command to the nodes
-     *     defined.
+     * @param route Specifies the routing configuration for the command. The client will route the
+     *     command to the nodes defined by <code>route</code>.
      * @return Response from Redis cluster with a <code>String</code> with the requested Sections.
      *     When specifying a <code>route</code> other than a single node, it returns a <code>
      *     Map{@literal <String, String>}</code> with each address as the key and its corresponding
@@ -64,8 +64,8 @@ public interface ServerManagementClusterCommands {
      * @param options A list of {@link InfoOptions.Section} values specifying which sections of
      *     information to retrieve. When no parameter is provided, the {@link
      *     InfoOptions.Section#DEFAULT} option is assumed.
-     * @param route Routing configuration for the command. Client will route the command to the nodes
-     *     defined.
+     * @param route Specifies the routing configuration for the command. The client will route the
+     *     command to the nodes defined by <code>route</code>.
      * @return Response from Redis cluster with a <code>String</code> with the requested sections.
      *     When specifying a <code>route</code> other than a single node, it returns a <code>
      *     Map{@literal <String, String>}</code> with each address as the key and its corresponding
@@ -92,8 +92,8 @@ public interface ServerManagementClusterCommands {
      * Rewrites the configuration file with the current configuration.
      *
      * @see <a href="https://redis.io/commands/config-rewrite/">redis.io</a> for details.
-     * @param route Routing configuration for the command. Client will route the command to the nodes
-     *     defined.
+     * @param route Specifies the routing configuration for the command. The client will route the
+     *     command to the nodes defined by <code>route</code>.
      * @return <code>OK</code> when the configuration was rewritten properly, otherwise an error is
      *     thrown.
      * @example
@@ -126,8 +126,8 @@ public interface ServerManagementClusterCommands {
      * href="https://redis.io/commands/latency-histogram/">LATENCY HISTOGRAM</a> commands.
      *
      * @see <a href="https://redis.io/commands/config-resetstat/">redis.io</a> for details.
-     * @param route Routing configuration for the command. Client will route the command to the nodes
-     *     defined.
+     * @param route Specifies the routing configuration for the command. The client will route the
+     *     command to the nodes defined by <code>route</code>.
      * @return <code>OK</code> to confirm that the statistics were successfully reset.
      * @example
      *     <pre>{@code