This is an automated email from the ASF dual-hosted git repository.
adoroszlai pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/ratis.git
The following commit(s) were added to refs/heads/master by this push:
new cda17df04 RATIS-2589. Fix Javadoc warnings (#1505)
cda17df04 is described below
commit cda17df04fc5180074f6cdd05d2f95aa3e1526b6
Author: Doroszlai, Attila <[email protected]>
AuthorDate: Tue Jul 7 07:07:50 2026 +0200
RATIS-2589. Fix Javadoc warnings (#1505)
---
.github/workflows/ci.yaml | 2 +-
dev-support/checks/compile.sh | 2 +-
.../src/main/java/org/apache/ratis/client/api/DataStreamInput.java | 5 +++--
.../java/org/apache/ratis/client/api/SnapshotManagementApi.java | 2 +-
ratis-common/src/main/java/org/apache/ratis/util/LifeCycle.java | 6 +++---
.../src/main/java/org/apache/ratis/server/DataStreamMap.java | 2 +-
.../java/org/apache/ratis/server/raftlog/RaftLogSequentialOps.java | 2 +-
.../src/main/java/org/apache/ratis/statemachine/StateMachine.java | 6 +++---
8 files changed, 14 insertions(+), 13 deletions(-)
diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml
index 03148f44d..3e35aa649 100644
--- a/.github/workflows/ci.yaml
+++ b/.github/workflows/ci.yaml
@@ -55,7 +55,7 @@ jobs:
java-version: ${{ matrix.java }}
needs-source-tarball: true
script: compile
- script-args: -Dmaven.compiler.release=${{ matrix.java }}
+ script-args: -Prelease -Dmaven.compiler.release=${{ matrix.java }}
-Dmaven.javadoc.failOnWarnings=${{ matrix.java != 8 }}
split: ${{ matrix.java }}
timeout-minutes: 30
secrets:
diff --git a/dev-support/checks/compile.sh b/dev-support/checks/compile.sh
index fba4394de..a5b037e40 100755
--- a/dev-support/checks/compile.sh
+++ b/dev-support/checks/compile.sh
@@ -20,7 +20,7 @@ source "${DIR}/../find_maven.sh"
: ${WITH_COVERAGE:="false"}
-MAVEN_OPTIONS='-V -B -Dmaven.javadoc.skip=true -DskipTests'
+MAVEN_OPTIONS='-V -B -DskipTests'
if [[ "${WITH_COVERAGE}" != "true" ]]; then
MAVEN_OPTIONS="${MAVEN_OPTIONS} -Djacoco.skip"
diff --git
a/ratis-client/src/main/java/org/apache/ratis/client/api/DataStreamInput.java
b/ratis-client/src/main/java/org/apache/ratis/client/api/DataStreamInput.java
index 0eff3cab1..210585216 100644
---
a/ratis-client/src/main/java/org/apache/ratis/client/api/DataStreamInput.java
+++
b/ratis-client/src/main/java/org/apache/ratis/client/api/DataStreamInput.java
@@ -30,8 +30,9 @@ public interface DataStreamInput extends Closeable {
/**
* Read the next chunk in the stream asynchronously.
* The caller owns the returned {@link DataStreamReply} which is a {@link
ReferenceCountedObject}.
- * and a {@link DataStreamPacket}. Access the buffer via {@link
DataStreamPacket#nioBuffer()}
- * or {@link DataStreamPacket#nioBuffers()}.
+ * and a {@link org.apache.ratis.protocol.DataStreamPacket}.
+ * Access the buffer via {@link
org.apache.ratis.protocol.DataStreamPacket#nioBuffer()}
+ * or {@link org.apache.ratis.protocol.DataStreamPacket#nioBuffers()}.
* It must call {@link ReferenceCountedObject#release()} after consuming it.
*
* @return a future of the reference-counted reply.
diff --git
a/ratis-client/src/main/java/org/apache/ratis/client/api/SnapshotManagementApi.java
b/ratis-client/src/main/java/org/apache/ratis/client/api/SnapshotManagementApi.java
index 359763fe9..b63bc3949 100644
---
a/ratis-client/src/main/java/org/apache/ratis/client/api/SnapshotManagementApi.java
+++
b/ratis-client/src/main/java/org/apache/ratis/client/api/SnapshotManagementApi.java
@@ -40,7 +40,7 @@ public interface SnapshotManagementApi {
/**
* Trigger to create a snapshot.
*
- * @param creationGap When (creationGap > 0) and (lastAppliedIndex -
lastSnapshotIndex < creationGap),
+ * @param creationGap When (creationGap > 0) and (lastAppliedIndex -
lastSnapshotIndex < creationGap),
* return lastSnapshotIndex; otherwise, take a new
snapshot and then return its index.
* When creationGap == 0, use the server configured value
as the creationGap.
* @return a reply. When {@link RaftClientReply#isSuccess()} is true,
diff --git a/ratis-common/src/main/java/org/apache/ratis/util/LifeCycle.java
b/ratis-common/src/main/java/org/apache/ratis/util/LifeCycle.java
index 86846b81d..ffcde12bd 100644
--- a/ratis-common/src/main/java/org/apache/ratis/util/LifeCycle.java
+++ b/ratis-common/src/main/java/org/apache/ratis/util/LifeCycle.java
@@ -40,13 +40,13 @@ import java.util.function.UnaryOperator;
* | -------------------------------- |
* | | ------------------------ | |
* | | | | | |
- * | | PAUSED <---- PAUSING---- | | |
+ * | | PAUSED «---- PAUSING---- | | |
* | | | ^ | | | | |
* | | V | | V V V V
- * NEW --> STARTING --> RUNNING --|--> CLOSING --> [CLOSED]
+ * NEW --» STARTING --» RUNNING --|--» CLOSING --» [CLOSED]
* ^ | | | | ^
* | | | V V |
- * ------- -------> EXCEPTION -----
+ * ------- -------» EXCEPTION -----
* </pre>
*/
public class LifeCycle {
diff --git
a/ratis-server-api/src/main/java/org/apache/ratis/server/DataStreamMap.java
b/ratis-server-api/src/main/java/org/apache/ratis/server/DataStreamMap.java
index 87905df38..d95baee52 100644
--- a/ratis-server-api/src/main/java/org/apache/ratis/server/DataStreamMap.java
+++ b/ratis-server-api/src/main/java/org/apache/ratis/server/DataStreamMap.java
@@ -29,6 +29,6 @@ public interface DataStreamMap {
CompletableFuture<DataStream> computeIfAbsent(ClientInvocationId
invocationId,
Function<ClientInvocationId, CompletableFuture<DataStream>>
newDataStream);
- /** Similar to {@link java.util.Map#remove(java.lang.Object). */
+ /** Similar to {@link java.util.Map#remove(java.lang.Object)}. */
CompletableFuture<DataStream> remove(ClientInvocationId invocationId);
}
diff --git
a/ratis-server-api/src/main/java/org/apache/ratis/server/raftlog/RaftLogSequentialOps.java
b/ratis-server-api/src/main/java/org/apache/ratis/server/raftlog/RaftLogSequentialOps.java
index 5e8bd6d78..5aa63f8e8 100644
---
a/ratis-server-api/src/main/java/org/apache/ratis/server/raftlog/RaftLogSequentialOps.java
+++
b/ratis-server-api/src/main/java/org/apache/ratis/server/raftlog/RaftLogSequentialOps.java
@@ -134,7 +134,7 @@ interface RaftLogSequentialOps {
/**
* The same as append(Arrays.asList(entries)).
*
- * @deprecated use {@link #append(List)}
+ * @deprecated use {@link RaftLogSequentialOps#append(List)}
*/
@Deprecated
default List<CompletableFuture<Long>> append(LogEntryProto... entries) {
diff --git
a/ratis-server-api/src/main/java/org/apache/ratis/statemachine/StateMachine.java
b/ratis-server-api/src/main/java/org/apache/ratis/statemachine/StateMachine.java
index 61e708feb..d2443d9b5 100644
---
a/ratis-server-api/src/main/java/org/apache/ratis/statemachine/StateMachine.java
+++
b/ratis-server-api/src/main/java/org/apache/ratis/statemachine/StateMachine.java
@@ -226,7 +226,7 @@ public interface StateMachine extends Closeable {
/**
* Notify the {@link StateMachine} that the server for this division has
been shut down.
- * @Deprecated please use/override {@link
#notifyServerShutdown(RoleInfoProto, boolean)} instead
+ * @deprecated please use/override {@link
#notifyServerShutdown(RoleInfoProto, boolean)} instead
*/
@Deprecated
default void notifyServerShutdown(RoleInfoProto roleInfo) {
@@ -503,7 +503,7 @@ public interface StateMachine extends Closeable {
CompletableFuture<Message> query(Message request);
/**
- * Query the state machine, provided minIndex <= commit index.
+ * Query the state machine, provided minIndex <= commit index.
* The request must be read-only.
* Since the commit index of this server may lag behind the Raft service,
* the returned result may possibly be stale.
@@ -511,7 +511,7 @@ public interface StateMachine extends Closeable {
* When minIndex > {@link #getLastAppliedTermIndex()},
* the state machine may choose to either
* (1) return exceptionally, or
- * (2) wait until minIndex <= {@link #getLastAppliedTermIndex()} before
running the query.
+ * (2) wait until minIndex <= {@link #getLastAppliedTermIndex()} before
running the query.
*/
CompletableFuture<Message> queryStale(Message request, long minIndex);
