refactor: Markdown reference links in Javadoc + checkstyle guard#32
Merged
Conversation
…eckstyle
Converts all 57 {@link ...} / {@linkplain ...} inline tags in /// Markdown
Javadoc to Markdown reference links ([ClassName#method(ParamType)]), matching
the project's stated convention.
Adds a checkstyle RegexpSingleline that bans {@link}/{@linkplain} in /// lines
so the old style cannot creep back, mirroring the existing {@code} ban. Also
fixes a latent bug in both rules' messages: checkstyle renders them with
MessageFormat, which threw "can't parse argument number" on the literal
{@code}/{@link} braces whenever a violation actually fired — reworded to avoid
braces.
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
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
1 participant
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.
What
{@link}/{@linkplain}inline tags in///Markdown Javadoc to Markdown reference links ([ClassName#method(ParamType)]), matching the project convention.RegexpSinglelinebanning{@link}/{@linkplain}in///lines so the old style can't return, mirroring the existing{@code}ban.MessageFormat, which threwcan't parse argument numberon the literal{@code}/{@link}braces whenever a violation actually fired. Reworded to avoid braces (verified the rule now fails with a readable message).Verify
228 tests green, checkstyle 0 violations, javadoc (failOnWarnings) clean. Confirmed the new rule fires on an injected
{@link}and reverts cleanly.🤖 Generated with Claude Code