This is an automated email from the ASF dual-hosted git repository.
hepin pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/pekko.git
The following commit(s) were added to refs/heads/main by this push:
new a293c8d4b9 Fix scaladoc links in actor APIs (#2780)
a293c8d4b9 is described below
commit a293c8d4b920fd770a5386e05bc4461ab1f7633b
Author: yangandfan <[email protected]>
AuthorDate: Tue Mar 24 00:48:34 2026 +0800
Fix scaladoc links in actor APIs (#2780)
---
.../scala/org/apache/pekko/actor/typed/ActorSystem.scala | 4 ++--
.../scala/org/apache/pekko/actor/typed/SpawnProtocol.scala | 2 +-
.../apache/pekko/actor/typed/javadsl/ActorContext.scala | 6 +++---
.../org/apache/pekko/actor/typed/javadsl/Behaviors.scala | 4 ++--
.../apache/pekko/actor/typed/scaladsl/ActorContext.scala | 2 +-
.../main/scala/org/apache/pekko/actor/AbstractProps.scala | 2 +-
.../main/scala/org/apache/pekko/actor/ActorSystem.scala | 14 +++++++-------
7 files changed, 17 insertions(+), 17 deletions(-)
diff --git
a/actor-typed/src/main/scala/org/apache/pekko/actor/typed/ActorSystem.scala
b/actor-typed/src/main/scala/org/apache/pekko/actor/typed/ActorSystem.scala
index d8a3b74913..98022a026a 100644
--- a/actor-typed/src/main/scala/org/apache/pekko/actor/typed/ActorSystem.scala
+++ b/actor-typed/src/main/scala/org/apache/pekko/actor/typed/ActorSystem.scala
@@ -152,7 +152,7 @@ abstract class ActorSystem[-T] extends ActorRef[T] with
Extensions with ClassicA
* [[pekko.actor.CoordinatedShutdown.ActorSystemTerminateReason]]. This
method will block
* until either the actor system is terminated or
* `pekko.coordinated-shutdown.close-actor-system-timeout` timeout duration
is
- * passed, in which case a [[TimeoutException]] is thrown.
+ * passed, in which case a [[java.util.concurrent.TimeoutException]] is
thrown.
*
* If `pekko.coordinated-shutdown.run-by-actor-system-terminate` is
configured to `off`
* it will not run `CoordinatedShutdown`, but the `ActorSystem` and its
actors
@@ -161,7 +161,7 @@ abstract class ActorSystem[-T] extends ActorRef[T] with
Extensions with ClassicA
* This will stop the guardian actor, which in turn
* will recursively stop all its child actors, and finally the system
guardian
* (below which the logging actors reside) and then execute all registered
- * termination handlers (see
[[pekko.actor.ActorSystem.registerOnTermination]]).
+ * termination handlers (see `registerOnTermination`).
* @since 1.3.0
*/
@throws(classOf[TimeoutException])
diff --git
a/actor-typed/src/main/scala/org/apache/pekko/actor/typed/SpawnProtocol.scala
b/actor-typed/src/main/scala/org/apache/pekko/actor/typed/SpawnProtocol.scala
index e3812eb532..3cab20efce 100644
---
a/actor-typed/src/main/scala/org/apache/pekko/actor/typed/SpawnProtocol.scala
+++
b/actor-typed/src/main/scala/org/apache/pekko/actor/typed/SpawnProtocol.scala
@@ -27,7 +27,7 @@ import pekko.annotation.DoNotInherit
* The typical usage of this is to use it as the guardian actor of the
[[ActorSystem]], possibly combined with
* `Behaviors.setup` to starts some initial tasks or actors. Child actors can
then be started from the outside
* by telling or asking [[SpawnProtocol#Spawn]] to the actor reference of the
system. When using `ask` this is
- * similar to how [[pekko.actor.ActorSystem#actorOf]] can be used in classic
actors with the difference that
+ * similar to how `actorOf` can be used in classic actors with the difference
that
* a `Future` / `CompletionStage` of the `ActorRef` is returned.
*
* Stopping children is done through specific support in the protocol of the
children, or stopping the entire
diff --git
a/actor-typed/src/main/scala/org/apache/pekko/actor/typed/javadsl/ActorContext.scala
b/actor-typed/src/main/scala/org/apache/pekko/actor/typed/javadsl/ActorContext.scala
index dac41e86be..77512eab00 100644
---
a/actor-typed/src/main/scala/org/apache/pekko/actor/typed/javadsl/ActorContext.scala
+++
b/actor-typed/src/main/scala/org/apache/pekko/actor/typed/javadsl/ActorContext.scala
@@ -37,7 +37,7 @@ import org.slf4j.Logger
* - designate the behavior for the next message
*
* In Pekko, the first capability is accessed by using the `tell` method
- * on an [[ActorRef]], the second is provided by [[ActorContext#spawn]]
+ * on an [[ActorRef]], the second is provided by `spawn`
* and the third is implicit in the signature of [[Behavior]] in that the next
* behavior is always returned from the message processing logic.
*
@@ -163,7 +163,7 @@ trait ActorContext[T] extends TypedActorContext[T] with
ClassicActorContextProvi
* using [[Behavior.interpretMessage]] or [[Behavior.interpretSignal]]
*
* note: if given [[pekko.actor.typed.Behavior]] resulting
[[Behaviors.same]] that will cause context switching to the given behavior
- * and if result is [[Behaviors.unhandled]] that will trigger the
[[pekko.actor.typed.scaladsl.ActorContext.onUnhandled]]
+ * and if result is [[Behaviors.unhandled]] that will mark the message as
unhandled
* then switching to the given behavior.
*/
def delegate(delegator: Behavior[T], msg: T): Behavior[T]
@@ -323,7 +323,7 @@ trait ActorContext[T] extends TypedActorContext[T] with
ClassicActorContextProvi
/**
* The same as [[ask]] but only for requests that result in a response of
type [[pekko.pattern.StatusReply]].
* If the response is a [[pekko.pattern.StatusReply#success]] the returned
future is completed successfully with the wrapped response.
- * If the status response is a [[pekko.pattern.StatusReply#error]] the
returned future will be failed with the
+ * If the status response is an error reply the returned future will be
failed with the
* exception in the error (normally a
[[pekko.pattern.StatusReply.ErrorMessage]]).
*/
def askWithStatus[Req, Res](
diff --git
a/actor-typed/src/main/scala/org/apache/pekko/actor/typed/javadsl/Behaviors.scala
b/actor-typed/src/main/scala/org/apache/pekko/actor/typed/javadsl/Behaviors.scala
index af15921512..df04d2e2db 100644
---
a/actor-typed/src/main/scala/org/apache/pekko/actor/typed/javadsl/Behaviors.scala
+++
b/actor-typed/src/main/scala/org/apache/pekko/actor/typed/javadsl/Behaviors.scala
@@ -38,7 +38,7 @@ object Behaviors {
/**
* `setup` is a factory for a behavior. Creation of the behavior instance is
deferred until
- * the actor is started, as opposed to [[Behaviors#receive]] that creates
the behavior instance
+ * the actor is started, as opposed to `receive` that creates the behavior
instance
* immediately before the actor is running. The `factory` function pass the
`ActorContext`
* as parameter and that can for example be used for spawning child actors.
*
@@ -125,7 +125,7 @@ object Behaviors {
new BehaviorImpl.ReceiveBehavior((ctx, msg) => onMessage.apply(ctx.asJava,
msg))
/**
- * Simplified version of [[receive]] with only a single argument - the
message
+ * Simplified version of `receive` with only a single argument - the message
* to be handled. Useful for when the context is already accessible by other
means,
* like being wrapped in an [[setup]] or similar.
*
diff --git
a/actor-typed/src/main/scala/org/apache/pekko/actor/typed/scaladsl/ActorContext.scala
b/actor-typed/src/main/scala/org/apache/pekko/actor/typed/scaladsl/ActorContext.scala
index 4e7a9d3328..577b75c3ca 100644
---
a/actor-typed/src/main/scala/org/apache/pekko/actor/typed/scaladsl/ActorContext.scala
+++
b/actor-typed/src/main/scala/org/apache/pekko/actor/typed/scaladsl/ActorContext.scala
@@ -146,7 +146,7 @@ trait ActorContext[T] extends TypedActorContext[T] with
ClassicActorContextProvi
* using [[Behavior.interpretMessage]] or [[Behavior.interpretSignal]]
*
* note: if given [[pekko.actor.typed.Behavior]] resulting
[[Behaviors.same]] that will cause context switching to the given behavior
- * and if result is [[Behaviors.unhandled]] that will trigger the
[[pekko.actor.typed.scaladsl.ActorContext.onUnhandled]]
+ * and if result is [[Behaviors.unhandled]] that will mark the message as
unhandled
* then switching to the given behavior.
*/
def delegate(delegator: Behavior[T], msg: T): Behavior[T]
diff --git a/actor/src/main/scala/org/apache/pekko/actor/AbstractProps.scala
b/actor/src/main/scala/org/apache/pekko/actor/AbstractProps.scala
index 4fa0d2dbe1..78912498f4 100644
--- a/actor/src/main/scala/org/apache/pekko/actor/AbstractProps.scala
+++ b/actor/src/main/scala/org/apache/pekko/actor/AbstractProps.scala
@@ -48,7 +48,7 @@ private[pekko] trait AbstractProps {
new Props(deploy = Props.defaultDeploy, clazz = clazz, args = args.toList)
/**
- * Create new Props from the given [[pekko.japi.Creator]] with the type set
to the given actorClass.
+ * Create new Props from the given [[pekko.japi.function.Creator]] with the
type set to the given actorClass.
*/
def create[T <: Actor](actorClass: Class[T], creator: Creator[T]): Props = {
checkCreatorClosingOver(creator.getClass)
diff --git a/actor/src/main/scala/org/apache/pekko/actor/ActorSystem.scala
b/actor/src/main/scala/org/apache/pekko/actor/ActorSystem.scala
index 95a263241b..6e7df09fda 100644
--- a/actor/src/main/scala/org/apache/pekko/actor/ActorSystem.scala
+++ b/actor/src/main/scala/org/apache/pekko/actor/ActorSystem.scala
@@ -547,7 +547,7 @@ abstract class ActorSystem extends ActorRefFactory with
ClassicActorSystemProvid
def logConfiguration(): Unit
/**
- * Construct a path below the application guardian to be used with
[[ActorSystem#actorSelection]].
+ * Construct a path below the application guardian to be used with
`actorSelection`.
*/
def /(name: String): ActorPath
@@ -557,7 +557,7 @@ abstract class ActorSystem extends ActorRefFactory with
ClassicActorSystemProvid
def child(child: String): ActorPath = /(child)
/**
- * Construct a path below the application guardian to be used with
[[ActorSystem#actorSelection]].
+ * Construct a path below the application guardian to be used with
`actorSelection`.
*/
def /(name: Iterable[String]): ActorPath
@@ -673,7 +673,7 @@ abstract class ActorSystem extends ActorRefFactory with
ClassicActorSystemProvid
* This will stop the guardian actor, which in turn
* will recursively stop all its child actors, and finally the system
guardian
* (below which the logging actors reside) and then execute all registered
- * termination handlers (see [[ActorSystem#registerOnTermination]]).
+ * termination handlers (see `registerOnTermination`).
* Be careful to not schedule any operations on completion of the returned
future
* using the dispatcher of this actor system as it will have been shut down
before the
* future completes.
@@ -685,7 +685,7 @@ abstract class ActorSystem extends ActorRefFactory with
ClassicActorSystemProvid
* [[CoordinatedShutdown.ActorSystemTerminateReason]]. This method will block
* until either the actor system is terminated or
* `pekko.coordinated-shutdown.close-actor-system-timeout` timeout duration
is
- * passed, in which case a [[TimeoutException]] is thrown.
+ * passed, in which case a [[java.util.concurrent.TimeoutException]] is
thrown.
*
* If `pekko.coordinated-shutdown.run-by-actor-system-terminate` is
configured to `off`
* it will not run `CoordinatedShutdown`, but the `ActorSystem` and its
actors
@@ -694,7 +694,7 @@ abstract class ActorSystem extends ActorRefFactory with
ClassicActorSystemProvid
* This will stop the guardian actor, which in turn
* will recursively stop all its child actors, and finally the system
guardian
* (below which the logging actors reside) and then execute all registered
- * termination handlers (see [[ActorSystem#registerOnTermination]]).
+ * termination handlers (see `registerOnTermination`).
* @since 1.3.0
*/
@throws(classOf[TimeoutException])
@@ -703,7 +703,7 @@ abstract class ActorSystem extends ActorRefFactory with
ClassicActorSystemProvid
/**
* Returns a Future which will be completed after the ActorSystem has been
terminated
* and termination hooks have been executed. If you registered any callback
with
- * [[ActorSystem#registerOnTermination]], the returned Future from this
method will not complete
+ * `registerOnTermination`, the returned Future from this method will not
complete
* until all the registered callbacks are finished. Be careful to not
schedule any operations,
* such as `onComplete`, on the dispatchers (`ExecutionContext`) of this
actor system as they
* will have been shut down before this future completes.
@@ -713,7 +713,7 @@ abstract class ActorSystem extends ActorRefFactory with
ClassicActorSystemProvid
/**
* Returns a CompletionStage which will be completed after the ActorSystem
has been terminated
* and termination hooks have been executed. If you registered any callback
with
- * [[ActorSystem#registerOnTermination]], the returned CompletionStage from
this method will not complete
+ * `registerOnTermination`, the returned CompletionStage from this method
will not complete
* until all the registered callbacks are finished. Be careful to not
schedule any operations,
* such as `thenRunAsync`, on the dispatchers (`Executor`) of this actor
system as they
* will have been shut down before this CompletionStage completes.
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
