Repository navigation
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Part of #7616 (STORM-3834). This first PR fixes all the javadoc errors; more will follow for the warnings.
What is the purpose of the change
Running the javadoc command from the release steps on master:
finishes with BUILD SUCCESS, but javadoc reports 124 errors (the Maven output stops at the first 100) and the generated pages carry "diagnostic markers for invalid input". All of them are comment problems:
<p/>is not allowed in HTML5 javadoc (67 of them). I turned these into a blank line plus<p>in front of the next paragraph, the style the checkstyleJavadocParagraphrule asks for<,>and&in text, e.g.<= 0,Map<>, the arrows inCheckPointStateandSupervisorClient: escaped, or wrapped in{@code}<li>without a surrounding list inBaseResourceAwareStrategy,ConstraintSolverStrategyandServerUtils: wrapped in<ul>/<ol></p>after a</ul>or</pre>, a stray<inOutputCollector,<pre><inRocksDbKey@throws ExceptiononCaptureLoad.checkInitialization, which doesn't throwFluxShellBolt/FluxShellSpoutbecame<pre>blocksI also fixed the six
empty <p> tagwarnings while I was there. Comments only, no code changes.The remaining ~18,400 warnings are almost all missing comments (
no comment,no @param,no @return, default constructors). That needs real doc text across many modules, so I'll split it into smaller PRs by module after this one, unless you'd rather handle the warnings differently.Happy to adjust if you'd prefer a different approach, or to split this PR by module if it's easier to review.
How was the change tested
With JDK 25 and Maven 3.9.11:
-Xmaxerrs), 0 after. Warnings went from 18,405 to 18,395. No more "diagnostic markers" note.mvn validate -Pexternals,examples -pl '!storm-shaded-deps'(checkstyle) passes.An AI assistant helped draft this change; I reviewed it and take responsibility for it.