fix: fix scaladoc warnings#3285
Open
He-Pin wants to merge 2 commits into
Open
Conversation
He-Pin
changed the title
He-Pin
force-pushed
the
fix/scaladoc-warnings
branch
from
927c3d2 to
65d0800
Compare
pjfanning
reviewed
Jul 5, 2026
He-Pin
added a commit
to He-Pin/incubator-pekko
that referenced
this pull request
Jul 5, 2026
…erences Motivation: PR apache#3285 review comment from pjfanning: "should we keep the package name?" The original [[pekko.stream.javadsl.Source.queue]] and [[pekko.stream.scaladsl.Source.queue]] links were replaced with just `Source.queue`, dropping the package name and making the reference ambiguous. Modification: Restore the fully qualified package names in the scaladoc "See also" references for both javadsl and scaladsl ActorSource.scala files. Result: Scaladoc references now include the full package path, making it clear which Source.queue class is being referenced. Tests: Not run - docs only References: Refs apache#3285
He-Pin
force-pushed
the
fix/scaladoc-warnings
branch
from
b37b2e9 to
8cd24b2
Compare
Motivation: The project had scaladoc warnings about unresolvable links, ambiguous overloads, and incorrect package prefixes across actor, actor-typed, stream, cluster, serialization-jackson, persistence, 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 - Fix @throws tags with fully qualified type names - Fix variable references in code blocks (Helpers.scala) Result: All scaladoc warnings are resolved across the affected modules. Tests: Verified with `sbt doc` on affected subprojects - 0 warnings. References: None - scaladoc cleanup
…erences Motivation: PR apache#3285 review comment from pjfanning: "should we keep the package name?" The original [[pekko.stream.javadsl.Source.queue]] and [[pekko.stream.scaladsl.Source.queue]] links were replaced with just `Source.queue`, dropping the package name and making the reference ambiguous. Modification: Restore the fully qualified package names in the scaladoc "See also" references for both javadsl and scaladsl ActorSource.scala files. Result: Scaladoc references now include the full package path, making it clear which Source.queue class is being referenced. Tests: Not run - docs only References: Refs apache#3285
He-Pin
force-pushed
the
fix/scaladoc-warnings
branch
from
8cd24b2 to
ae96916
Compare
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
2 participants
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.
Summary
[[...]]links with backtick-quoted code for external types (Future,AutoCloseable,NoSuchElementException,LoggingAdapter,MarkerLoggingAdapter,SessionBytes, etc.)alsoTo,wireTap,takeWhile,splitWhen,splitAfter,groupBy,flatMapConcat,throttle,dropRepeated,deflate,gzip, etc.)@throwstags with fully qualified type namesWireTap,OrElse,GraphInterpreter,BarrierCoordinator)pekko.toorg.apache.pekko.)Test plan
sbt actor/doccompletes with 0 Scala warningssbt stream/docshows significantly reduced warningssbt actor-testkit-typed/doccompletes with 0 warnings