Skip to content

RATIS-2589. Fix Javadoc warnings#1505

Open
adoroszlai wants to merge 8 commits into
apache:masterfrom
adoroszlai:RATIS-2589
Open

RATIS-2589. Fix Javadoc warnings#1505
adoroszlai wants to merge 8 commits into
apache:masterfrom
adoroszlai:RATIS-2589

Conversation

@adoroszlai

Copy link
Copy Markdown
Contributor

What changes were proposed in this pull request?

  • Fix Javadoc warnings.
  • Fail compile check on Javadoc warnings, except with version 1.8, which reports the following false positives:
ratis-server-api/src/main/java/org/apache/ratis/statemachine/StateMachine.java:375: warning - Tag @link: can't find link(DataStream, LogEntryProto) in org.apache.ratis.statemachine.StateMachine.DataApi
ratis-server-api/src/main/java/org/apache/ratis/statemachine/StateMachine.java:232: warning - Tag @link: can't find notifyServerShutdown(RoleInfoProto, boolean) in org.apache.ratis.statemachine.StateMachine.EventApi
ratis-server-api/src/main/java/org/apache/ratis/statemachine/StateMachine.java:265: warning - Tag @link: can't find notifyFollowerSlowness(RoleInfoProto, RaftPeer) in org.apache.ratis.statemachine.StateMachine.LeaderEventApi
ratis-grpc/src/main/java/org/apache/ratis/grpc/util/ZeroCopyMessageMarshaller.java:222: warning - Tag @link: can't find release(T) in org.apache.ratis.grpc.util.ZeroCopyMessageMarshaller

https://issues.apache.org/jira/browse/RATIS-2589

How was this patch tested?

https://github.com/adoroszlai/ratis/actions/runs/28638905538

@szetszwo szetszwo left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@adoroszlai , thanks for working on this! Just a comment inlined.

Comment on lines +43 to +49
* | | PAUSED <---- PAUSING---- | | |
* | | PAUSED &lt;---- PAUSING---- | | |
* | | | ^ | | | | |
* | | V | | V V V V
* NEW --> STARTING --> RUNNING --|--> CLOSING --> [CLOSED]
* NEW --&gt; STARTING --&gt; RUNNING --|--&gt; CLOSING --&gt; [CLOSED]
* ^ | | | | ^
* | | | V V |
* ------- -------> EXCEPTION -----
* ------- -------&gt; EXCEPTION -----

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's use » and « . It will be easy to read the javadoc in the source.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the hint, it really reads better.

@szetszwo szetszwo left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

+1 the change looks good.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants