Skip to content

Commit

Permalink
Update javadoc and config for maven-javadoc-plugin 3 (#3257)
Browse files Browse the repository at this point in the history
  • Loading branch information
sazzad16 authored Dec 26, 2022
1 parent 9189549 commit c5e27ae
Show file tree
Hide file tree
Showing 16 changed files with 105 additions and 203 deletions.
6 changes: 4 additions & 2 deletions pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -174,8 +174,10 @@
<artifactId>maven-javadoc-plugin</artifactId>
<version>3.4.1</version>
<configuration>
<aggregate>true</aggregate>
<additionalparam>-Xdoclint:none</additionalparam>
<source>8</source><!-- Until JDK 11+ -->
<detectJavaApiLink>false</detectJavaApiLink><!-- Until JDK 11+ -->
<!--<doclint>none</doclint>-->
<!--<doclint>all,-missing</doclint>-->
</configuration>
<executions>
<execution>
Expand Down
3 changes: 1 addition & 2 deletions src/main/java/redis/clients/jedis/BuilderFactory.java
Original file line number Diff line number Diff line change
Expand Up @@ -838,7 +838,7 @@ public String toString() {
};

/**
* Create a AccessControlUser object from the ACL GETUSER < > result
* Create a AccessControlUser object from the ACL GETUSER reply.
*/
public static final Builder<AccessControlUser> ACCESS_CONTROL_USER = new Builder<AccessControlUser>() {
@SuppressWarnings("unchecked")
Expand Down Expand Up @@ -1868,7 +1868,6 @@ public Map.Entry<Long, byte[]> build(Object data) {
* values. The resulting set displays the same ordering, concurrency, and performance
* characteristics as the backing list. This class should be used only for Redis commands which
* return Set result.
* @param <E>
*/
protected static class SetFromList<E> extends AbstractSet<E> implements Serializable {
private static final long serialVersionUID = -2850347066962734052L;
Expand Down
15 changes: 15 additions & 0 deletions src/main/java/redis/clients/jedis/CommandObjects.java
Original file line number Diff line number Diff line change
Expand Up @@ -646,6 +646,10 @@ public final CommandObject<Long> bitop(BitOP op, byte[] destKey, byte[]... srcKe
}

/**
* @param keyA
* @param keyB
* @param params
* @return
* @deprecated STRALGO LCS command will be removed from Redis 7.
* LCS can be used instead of this method.
*/
Expand All @@ -656,6 +660,10 @@ public final CommandObject<LCSMatchResult> strAlgoLCSKeys(String keyA, String ke
}

/**
* @param keyA
* @param keyB
* @param params
* @return
* @deprecated STRALGO LCS command will be removed from Redis 7.
* LCS can be used instead of this method.
*/
Expand Down Expand Up @@ -2440,6 +2448,13 @@ public final CommandObject<StreamPendingSummary> xpending(String key, String gro
}

/**
* @param key
* @param groupName
* @param start
* @param end
* @param count
* @param consumerName
* @return
* @deprecated Use {@link CommandObjects#xpending(java.lang.String, java.lang.String, redis.clients.jedis.params.XPendingParams)}.
*/
@Deprecated
Expand Down
10 changes: 3 additions & 7 deletions src/main/java/redis/clients/jedis/Jedis.java
Original file line number Diff line number Diff line change
Expand Up @@ -657,9 +657,7 @@ public long dbSize() {
* @see <a href="http://redis.io/commands/expire">Expire Command</a>
* @param key
* @param seconds
* @return 1: the timeout was set. 0: the timeout was not set since
* the key already has an associated timeout (this may happen only in Redis versions &lt;
* 2.1.3, Redis &gt;= 2.1.3 will happily update the timeout), or the key does not exist.
* @return 1: the timeout was set. 0: the timeout was not set.
*/
@Override
public long expire(final byte[] key, final long seconds) {
Expand Down Expand Up @@ -690,9 +688,7 @@ public long expire(final byte[] key, final long seconds, final ExpiryOption expi
* @see <a href="http://redis.io/commands/pexpire">PEXPIRE Command</a>
* @param key
* @param milliseconds
* @return 1: the timeout was set. 0: the timeout was not set since
* the key already has an associated timeout (this may happen only in Redis versions <
* 2.1.3, Redis >= 2.1.3 will happily update the timeout), or the key does not exist.
* @return 1: the timeout was set. 0: the timeout was not set.
*/
@Override
public long pexpire(final byte[] key, final long milliseconds) {
Expand Down Expand Up @@ -4861,7 +4857,7 @@ public boolean copy(String srcKey, String dstKey, boolean replace) {
}

/**
* Works same as <tt>ping()</tt> but returns argument message instead of <tt>PONG</tt>.
* Works same as {@link #ping()} but returns argument message instead of PONG.
* @param message
* @return message
*/
Expand Down
6 changes: 2 additions & 4 deletions src/main/java/redis/clients/jedis/StreamEntryID.java
Original file line number Diff line number Diff line change
Expand Up @@ -113,10 +113,8 @@ public String toString() {

/**
* Should be used only with XREADGROUP
*
* <code>
* XREADGROUP $GroupName $ConsumerName BLOCK 2000 COUNT 10 STREAMS mystream >
* </code>
* <p>
* {@code XREADGROUP $GroupName $ConsumerName BLOCK 2000 COUNT 10 STREAMS mystream >}
*/
public static final StreamEntryID UNRECEIVED_ENTRY = new StreamEntryID() {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ public interface FunctionBinaryCommands {
* @param name
* @param keys
* @param args
* @return
*/
Object fcall(byte[] name, List<byte[]> keys, List<byte[]> args);

Expand Down Expand Up @@ -88,11 +89,12 @@ public interface FunctionBinaryCommands {

/**
* Load a library to Redis.
* @param functionCode the source code. The library payload must start
* with Shebang statement that provides a metadata
* about the library (like the engine to use and the library name).
* Shebang format: #!<engine name> name=<library name>.
* Currently engine name must be lua.
* <p>
* The library payload must start with Shebang statement that provides a metadata about the
* library (like the engine to use and the library name). Shebang format:
* {@code #!<engine name> name=<library name>}. Currently engine name must be lua.
*
* @param functionCode the source code.
* @return The library name that was loaded
*/
String functionLoad(byte[] functionCode);
Expand Down
11 changes: 6 additions & 5 deletions src/main/java/redis/clients/jedis/commands/FunctionCommands.java
Original file line number Diff line number Diff line change
Expand Up @@ -92,11 +92,12 @@ public interface FunctionCommands {

/**
* Load a library to Redis.
* @param functionCode the source code. The library payload must start
* with Shebang statement that provides a metadata
* about the library (like the engine to use and the library name).
* Shebang format: #!<engine name> name=<library name>.
* Currently engine name must be lua.
* <p>
* The library payload must start with Shebang statement that provides a metadata about the
* library (like the engine to use and the library name). Shebang format:
* {@code #!<engine name> name=<library name>}. Currently engine name must be lua.
*
* @param functionCode the source code.
* @return The library name that was loaded
*/
String functionLoad(String functionCode);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ public interface ServerCommands {

/**
* Delete all the keys of all the existing databases, not just the currently selected one.
* @param flushMode
* @param flushMode SYNC or ASYNC
* @return a simple string reply (OK)
*/
String flushAll(FlushMode flushMode);
Expand All @@ -53,16 +53,13 @@ public interface ServerCommands {
* requirepass directive in the configuration file. If password matches the password in the
* configuration file, the server replies with the OK status code and starts accepting commands.
* Otherwise, an error is returned and the clients needs to try a new password.
* @param password
* @return the result of the auth
*/
String auth(String password);

/**
* Request for authentication with username and password, based on the ACL feature introduced in
* Redis 6.0 see https://redis.io/topics/acl
* @param user
* @param password
* @return OK
*/
String auth(String user, String password);
Expand Down
Loading

0 comments on commit c5e27ae

Please sign in to comment.