Skip to content

Commit c18b1d3

Browse files
committed
fix: fix scaladoc warnings across all modules
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
1 parent 2610cda commit c18b1d3

57 files changed

Lines changed: 257 additions & 257 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

actor-testkit-typed/src/main/scala/org/apache/pekko/actor/testkit/typed/Effect.scala

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -49,8 +49,8 @@ object Effect {
4949
* The 'replyToRef' is exposed so that the target inbox can expect the actual message sent to
5050
* initiate the ask.
5151
*
52-
* Note that this requires the ask to be initiated via the [[ActorContext]]. The [[Future]] returning
53-
* ask is not testable in the [[BehaviorTestKit]].
52+
* Note that this requires the ask to be initiated via the [[ActorContext]]. The `Future` returning
53+
* ask is not testable in the `BehaviorTestKit`.
5454
*/
5555
final case class AskInitiated[Req, Res, T](target: RecipientRef[Req],
5656
responseTimeout: FiniteDuration,

actor-testkit-typed/src/main/scala/org/apache/pekko/actor/testkit/typed/javadsl/BehaviorTestKit.scala

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@ abstract class BehaviorTestKit[T] {
8686
def runAsk[Res](messageFactory: JFunction[ActorRef[Res], T]): ReplyInbox[Res]
8787

8888
/**
89-
* The same as [[runAsk]], but with the response class specified. This improves type inference in Java
89+
* The same as `runAsk`, but with the response class specified. This improves type inference in Java
9090
* when asserting on the reply in the same statement as the `runAsk` as in:
9191
*
9292
* ```
@@ -102,14 +102,14 @@ abstract class BehaviorTestKit[T] {
102102
runAsk(messageFactory)
103103

104104
/**
105-
* The same as [[runAsk]] but only for requests that result in a response of type [[pekko.pattern.StatusReply]].
105+
* The same as `runAsk` but only for requests that result in a response of type [[pekko.pattern.StatusReply]].
106106
*
107107
* @since 1.3.0
108108
*/
109109
def runAskWithStatus[Res](messageFactory: JFunction[ActorRef[StatusReply[Res]], T]): StatusReplyInbox[Res]
110110

111111
/**
112-
* The same as [[runAskWithStatus]], but with the response class specified. This improves type inference in
112+
* The same as `runAskWithStatus`, but with the response class specified. This improves type inference in
113113
* Java when asserting on the reply in the same statement as the `runAskWithStatus` as in:
114114
*
115115
* ```

actor-testkit-typed/src/main/scala/org/apache/pekko/actor/testkit/typed/javadsl/TestKitJUnit5Extension.scala

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ final class TestKitJUnit5Extension() extends AfterAllCallback with BeforeTestExe
2828
var testKit: Option[ActorTestKit] = None
2929

3030
/**
31-
* Get a reference to the field annotated with `@JUnit5Testkit` [[JUnit5TestKit]]
31+
* Get a reference to the field annotated with `@JUnit5TestKit`
3232
*/
3333
override def beforeTestExecution(context: ExtensionContext): Unit = {
3434
val testInstance: Option[AnyRef] =

actor-testkit-typed/src/main/scala/org/apache/pekko/actor/testkit/typed/javadsl/TestKitJUnitJupiterExtension.scala

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ final class TestKitJUnitJupiterExtension() extends AfterAllCallback with BeforeT
2727
var testKit: Option[ActorTestKit] = None
2828

2929
/**
30-
* Get a reference to the field annotated with `@JUnitJupiterTestKit` [[JUnitJupiterTestKit]]
30+
* Get a reference to the field annotated with `@JUnitJupiterTestKit` `JUnitJupiterTestKit`
3131
*/
3232
override def beforeTestExecution(context: ExtensionContext): Unit = {
3333
val testInstance: Option[AnyRef] =

actor-testkit-typed/src/main/scala/org/apache/pekko/actor/testkit/typed/javadsl/TestProbe.scala

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -69,8 +69,8 @@ object TestProbe {
6969
}
7070

7171
/**
72-
* Java API: * Create instances through the `create` factories in the [[TestProbe]] companion
73-
* or via [[ActorTestKit#createTestProbe]].
72+
* Java API: Create instances through the `create` factories in the `TestProbe` companion
73+
* or via `ActorTestKit.createTestProbe`.
7474
*
7575
* A test probe is essentially a queryable mailbox which can be used in place of an actor and the received
7676
* messages can then be asserted etc.

actor-typed/src/main/scala/org/apache/pekko/actor/typed/ActorSystem.scala

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ import com.typesafe.config.{ Config, ConfigFactory }
3434

3535
/**
3636
* An ActorSystem is home to a hierarchy of Actors. It is created using
37-
* [[ActorSystem#apply]] from a [[Behavior]] object that describes the root
37+
* `ActorSystem.apply` from a [[Behavior]] object that describes the root
3838
* Actor of this hierarchy and which will create all other Actors beneath it.
3939
* A system also implements the [[ActorRef]] type, and sending a message to
4040
* the system directs that message to the root Actor.

actor-typed/src/main/scala/org/apache/pekko/actor/typed/SupervisorStrategy.scala

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ object SupervisorStrategy {
3636

3737
/**
3838
* Restart immediately without any limit on number of restart retries. A limit can be
39-
* added with [[RestartSupervisorStrategy.withLimit]].
39+
* added with `RestartSupervisorStrategy.withLimit`.
4040
*
4141
* If the actor behavior is deferred and throws an exception on startup the actor is stopped
4242
* (restarting would be dangerous as it could lead to an infinite restart-loop)
@@ -358,7 +358,7 @@ sealed abstract class BackoffSupervisorStrategy extends SupervisorStrategy {
358358
* The initial errors are logged at the level defined with [[BackoffSupervisorStrategy.withLogLevel]].
359359
* For example, the first 3 errors can be logged at INFO level and thereafter at ERROR level.
360360
*
361-
* The counter (and log level) is reset after the [[BackoffSupervisorStrategy.withResetBackoffAfter]]
361+
* The counter (and log level) is reset after the `BackoffSupervisorStrategy.withResetBackoffAfter`
362362
* duration.
363363
*/
364364
def withCriticalLogLevel(criticalLevel: Level, afterErrors: Int): BackoffSupervisorStrategy

actor-typed/src/main/scala/org/apache/pekko/actor/typed/javadsl/AskPattern.scala

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ object AskPattern {
5555
/**
5656
* The same as [[ask]] but only for requests that result in a response of type [[pekko.pattern.StatusReply]].
5757
* If the response is a [[pekko.pattern.StatusReply#success]] the returned future is completed successfully with the wrapped response.
58-
* If the status response is a [[pekko.pattern.StatusReply#error]] the returned future will be failed with the
58+
* If the status response is a `StatusReply.error` the returned future will be failed with the
5959
* exception in the error (normally a [[pekko.pattern.StatusReply.ErrorMessage]]).
6060
*/
6161
def askWithStatus[Req, Res](

actor/src/main/scala/org/apache/pekko/actor/ActorSelection.scala

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@ abstract class ActorSelection extends Serializable {
9595
def resolveOne(timeout: FiniteDuration): Future[ActorRef] = resolveOne()(timeout)
9696

9797
/**
98-
* Java API for [[#resolveOne]]
98+
* Java API for `resolveOne`
9999
*
100100
* Resolve the [[ActorRef]] matching this selection.
101101
* The result is returned as a CompletionStage that is completed with the [[ActorRef]]
@@ -337,7 +337,7 @@ private[pekko] case object SelectParent extends SelectionPathElement {
337337
}
338338

339339
/**
340-
* When [[ActorSelection#resolveOne]] can't identify the actor the
340+
* When `ActorSelection.resolveOne` can't identify the actor the
341341
* `Future` is completed with this failure.
342342
*/
343343
@SerialVersionUID(1L)

actor/src/main/scala/org/apache/pekko/actor/FSM.scala

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -693,7 +693,7 @@ trait FSM[S, D] extends Actor with Listeners with ActorLogging {
693693
*
694694
* An initial `currentState -> currentState` notification will be triggered by calling this method.
695695
*
696-
* @see [[#startWith]]
696+
* @see `startWith`
697697
*/
698698
final def initialize(): Unit =
699699
if (currentState ne null) makeTransition(currentState)

0 commit comments

Comments
 (0)