Skip to content

Fix javadoc warnings across the codebase#1778

Merged
tfenne merged 1 commit into
devfrom
tf_fix_javadoc
Apr 29, 2026
Merged

Fix javadoc warnings across the codebase#1778
tfenne merged 1 commit into
devfrom
tf_fix_javadoc

Conversation

@tfenne
Copy link
Copy Markdown
Member

@tfenne tfenne commented Apr 29, 2026

Summary

  • Clears all 100 warnings produced by ./gradlew javadoc.
  • Doc-only edits across ~40 files; no behavioral changes.
  • Categories addressed: unescaped </<=/& in doc text, malformed @link references (missing braces, invalid this#, double-# chains), an unresolved package reference, an unclosed @code tag, @return tags on void/constructor doc, and a duplicate @param.

Test plan

  • ./gradlew javadoc --rerun-tasks reports 0 warnings
  • ./gradlew compileJava succeeds
  • ./gradlew spotlessApply produces no further changes

@tfenne
Fix javadoc warnings across the codebase.
708d56c 
Cleans up 100 javadoc warnings flagged by the javadoc target. Fixes fall
into a few well-defined categories: unescaped angle brackets and
ampersands in doc text, malformed @link references (missing braces,
invalid this#, double-# chains), an unresolved package reference, an
unclosed @code tag, @return tags on void methods and constructors, and a
duplicate @param. Doc-only changes; no behavioral impact.
@tfenne tfenne merged commit fb57878 into dev Apr 29, 2026
7 of 8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@tfenne