Skip to content

fix: fix scaladoc warnings across all modules#1120

Merged
He-Pin merged 1 commit into
apache:mainfrom
He-Pin:fix/scaladoc-warnings
Jul 6, 2026
Merged

fix: fix scaladoc warnings across all modules#1120
He-Pin merged 1 commit into
apache:mainfrom
He-Pin:fix/scaladoc-warnings

Conversation

@He-Pin

@He-Pin He-Pin commented Jul 4, 2026

Copy link
Copy Markdown
Member

Summary

  • Fix ~130 scaladoc warnings across 61 files in http-core, http, http-testkit, and other modules
  • Replace unresolvable [[...]] links with backtick-quoted code for external types
  • Fix incorrect package prefixes (pekko.org.apache.pekko.)
  • Resolve ambiguous overload links using backtick-quoted code

Test plan

  • sbt doc completes with 0 warnings
  • No functional changes, documentation only

@He-Pin He-Pin requested a review from pjfanning July 4, 2026 14:31
@He-Pin He-Pin force-pushed the fix/scaladoc-warnings branch from deff2a0 to 34dd73b Compare July 5, 2026 05:44
@He-Pin He-Pin marked this pull request as draft July 6, 2026 11:59
Motivation:
The project had ~130 scaladoc warnings about unresolvable links,
ambiguous overloads, and incorrect package prefixes across http-core,
http, http-testkit, and other modules.

Modification:
- Replace unresolvable [[...]] links with backtick-quoted code for external types
- Fix incorrect package prefixes (pekko. -> org.apache.pekko.)
- Resolve ambiguous overload links using backtick-quoted code
- Restore full package path in EnhancedString#secure_== references

Result:
All scaladoc warnings are resolved. No functional changes.

Tests:
Not run - docs only

References:
None - scaladoc cleanup
@He-Pin He-Pin force-pushed the fix/scaladoc-warnings branch from 34dd73b to 20784a4 Compare July 6, 2026 15:53
@He-Pin He-Pin marked this pull request as ready for review July 6, 2026 15:56
@He-Pin He-Pin requested a review from pjfanning July 6, 2026 15:56

@pjfanning pjfanning left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

lgtm

@He-Pin He-Pin merged commit 5f6cb86 into apache:main Jul 6, 2026
6 checks passed
@He-Pin He-Pin deleted the fix/scaladoc-warnings branch July 6, 2026 16:41
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