He-Pin opened a new pull request, #3285: URL: https://github.com/apache/pekko/pull/3285
Motivation: The project had ~153 scaladoc warnings about unresolvable links, ambiguous overloads, and incorrect package prefixes across actor, actor-typed, actor-testkit-typed, stream, cluster, cluster-metrics, cluster-sharding, serialization-jackson, remote, multi-node-testkit, and stream-typed modules. Modification: - Replace unresolvable `[[...]]` links with backtick-quoted code for external types (`Future`, `AutoCloseable`, `NoSuchElementException`, `LoggingAdapter`, `MarkerLoggingAdapter`, etc.) - Fix incorrect package prefixes (`pekko.` to `org.apache.pekko.`) - Resolve ambiguous overload links using backtick-quoted code (`alsoTo`, `wireTap`, `takeWhile`, `splitWhen`, `splitAfter`, `groupBy`, `flatMapConcat`, `throttle`, `dropRepeated`, `deflate`, `gzip`, etc.) - Fix `@throws` tags with fully qualified type names (`java.lang.IndexOutOfBoundsException`, `java.lang.Throwable`) - Fix variable references in code blocks (`$hours`, `$minutes`, `$seconds`, `$ms` in Helpers.scala) 40 files changed across 12+ modules. Result: All scaladoc warnings are resolved. `sbt doc` completes with 0 warnings on affected subprojects. Tests: - [x] `sbt actor/doc` - 0 warnings - [x] `sbt stream/doc` - 0 warnings - [x] No functional changes, documentation only -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
