fix: fix scaladoc warnings

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

@@ -49,8 +49,8 @@ object Effect {
    * The 'replyToRef' is exposed so that the target inbox can expect the actual message sent to
    * initiate the ask.
    *
-   * Note that this requires the ask to be initiated via the [[ActorContext]].  The [[Future]] returning
-   * ask is not testable in the [[BehaviorTestKit]].
+   * Note that this requires the ask to be initiated via the [[ActorContext]].  The `Future` returning
+   * ask is not testable in the `BehaviorTestKit`.
    */
   final case class AskInitiated[Req, Res, T](target: RecipientRef[Req],
       responseTimeout: FiniteDuration,

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

@@ -86,7 +86,7 @@ abstract class BehaviorTestKit[T] {
   def runAsk[Res](messageFactory: JFunction[ActorRef[Res], T]): ReplyInbox[Res]
 
   /**
-   * The same as [[runAsk]], but with the response class specified.  This improves type inference in Java
+   * The same as `runAsk`, but with the response class specified.  This improves type inference in Java
    * when asserting on the reply in the same statement as the `runAsk` as in:
    *
    * ```
@@ -102,14 +102,14 @@ abstract class BehaviorTestKit[T] {
     runAsk(messageFactory)
 
   /**
-   * The same as [[runAsk]] but only for requests that result in a response of type [[pekko.pattern.StatusReply]].
+   * The same as `runAsk` but only for requests that result in a response of type [[pekko.pattern.StatusReply]].
    *
    * @since 1.3.0
    */
   def runAskWithStatus[Res](messageFactory: JFunction[ActorRef[StatusReply[Res]], T]): StatusReplyInbox[Res]
 
   /**
-   * The same as [[runAskWithStatus]], but with the response class specified.  This improves type inference in
+   * The same as `runAskWithStatus`, but with the response class specified.  This improves type inference in
    * Java when asserting on the reply in the same statement as the `runAskWithStatus` as in:
    *
    * ```

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

@@ -28,7 +28,7 @@ final class TestKitJUnit5Extension() extends AfterAllCallback with BeforeTestExe
   var testKit: Option[ActorTestKit] = None
 
   /**
-   * Get a reference to the field annotated with `@JUnit5Testkit` [[JUnit5TestKit]]
+   * Get a reference to the field annotated with `@JUnit5TestKit`
    */
   override def beforeTestExecution(context: ExtensionContext): Unit = {
     val testInstance: Option[AnyRef] =

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

@@ -27,7 +27,7 @@ final class TestKitJUnitJupiterExtension() extends AfterAllCallback with BeforeT
   var testKit: Option[ActorTestKit] = None
 
   /**
-   * Get a reference to the field annotated with `@JUnitJupiterTestKit` [[JUnitJupiterTestKit]]
+   * Get a reference to the field annotated with `@JUnitJupiterTestKit` `JUnitJupiterTestKit`
    */
   override def beforeTestExecution(context: ExtensionContext): Unit = {
     val testInstance: Option[AnyRef] =

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

@@ -69,8 +69,8 @@ object TestProbe {
 }
 
 /**
- * Java API: * Create instances through the `create` factories in the [[TestProbe]] companion
- * or via [[ActorTestKit#createTestProbe]].
+ * Java API: Create instances through the `create` factories in the `TestProbe` companion
+ * or via `ActorTestKit.createTestProbe`.
  *
  * A test probe is essentially a queryable mailbox which can be used in place of an actor and the received
  * messages can then be asserted etc.

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

@@ -34,7 +34,7 @@ import com.typesafe.config.{ Config, ConfigFactory }
 
 /**
  * An ActorSystem is home to a hierarchy of Actors. It is created using
- * [[ActorSystem#apply]] from a [[Behavior]] object that describes the root
+ * `ActorSystem.apply` from a [[Behavior]] object that describes the root
  * Actor of this hierarchy and which will create all other Actors beneath it.
  * A system also implements the [[ActorRef]] type, and sending a message to
  * the system directs that message to the root Actor.

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

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

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

@@ -55,7 +55,7 @@ object AskPattern {
   /**
    * 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 a `StatusReply.error` the returned future will be failed with the
    * exception in the error (normally a [[pekko.pattern.StatusReply.ErrorMessage]]).
    */
   def askWithStatus[Req, Res](

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

@@ -95,7 +95,7 @@ abstract class ActorSelection extends Serializable {
   def resolveOne(timeout: FiniteDuration): Future[ActorRef] = resolveOne()(timeout)
 
   /**
-   * Java API for [[#resolveOne]]
+   * Java API for `resolveOne`
    *
    * Resolve the [[ActorRef]] matching this selection.
    * The result is returned as a CompletionStage that is completed with the [[ActorRef]]
@@ -337,7 +337,7 @@ private[pekko] case object SelectParent extends SelectionPathElement {
 }
 
 /**
- * When [[ActorSelection#resolveOne]] can't identify the actor the
+ * When `ActorSelection.resolveOne` can't identify the actor the
  * `Future` is completed with this failure.
  */
 @SerialVersionUID(1L)

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

@@ -693,7 +693,7 @@ trait FSM[S, D] extends Actor with Listeners with ActorLogging {
    *
    * An initial `currentState -> currentState` notification will be triggered by calling this method.
    *
-   * @see [[#startWith]]
+   * @see `startWith`
    */
   final def initialize(): Unit =
     if (currentState ne null) makeTransition(currentState)

actor/src/main/scala/org/apache/pekko/dispatch/Dispatchers.scala

@@ -325,7 +325,7 @@ private[pekko] object BalancingDispatcherConfigurator {
 }
 
 /**
- * Configurator for creating [[pekko.dispatch.BalancingDispatcher]].
+ * Configurator for creating `BalancingDispatcher`.
  * Returns the same dispatcher instance for each invocation
  * of the `dispatcher()` method.
  */

actor/src/main/scala/org/apache/pekko/io/dns/DnsProtocol.scala

@@ -57,7 +57,7 @@ object DnsProtocol {
   def srvRequestType(): RequestType = Srv
 
   /**
-   * Sending this to the [[internal.AsyncDnsManager]] will either lead to a [[Resolved]] or a [[pekko.actor.Status.Failure]] response.
+   * Sending this to the `AsyncDnsManager` will either lead to a [[Resolved]] or a [[pekko.actor.Status.Failure]] response.
    * If request type are both, both resolutions must succeed or the response is a failure.
    */
   final case class Resolve(name: String, requestType: RequestType) extends ConsistentHashable {

actor/src/main/scala/org/apache/pekko/japi/Throwables.scala

@@ -53,7 +53,7 @@ object Throwables {
   /**
    * Throws the given `Throwable`, without requiring the caller to declare it in a `throws` clause.
    * @param t the `Throwable` to throw
-   * @throws T the type of the `Throwable` to throw
+   * @throws java.lang.Throwable the type of the `Throwable` to throw
    * @return never returns normally, but has return type `R` to allow usage in expressions
    * @since 2.0.0
    */

actor/src/main/scala/org/apache/pekko/pattern/BackoffOptions.scala

@@ -56,7 +56,7 @@ object BackoffOpts {
    * This supervisor should not be used with `Pekko Persistence` child actors.
    * `Pekko Persistence` actors shutdown unconditionally on `persistFailure()`s rather
    * than throw an exception on a failure like normal actors.
-   * [[#onStop]] should be used instead for cases where the child actor
+   * `onStop` should be used instead for cases where the child actor
    * terminates itself as a failure signal instead of the normal behavior of throwing an exception.
    * ***'''
    * You can define another
@@ -110,7 +110,7 @@ object BackoffOpts {
    * This supervisor should not be used with `Pekko Persistence` child actors.
    * `Pekko Persistence` actors shutdown unconditionally on `persistFailure()`s rather
    * than throw an exception on a failure like normal actors.
-   * [[#onStop]] should be used instead for cases where the child actor
+   * `onStop` should be used instead for cases where the child actor
    * terminates itself as a failure signal instead of the normal behavior of throwing an exception.
    * ***'''
    * You can define another
@@ -284,7 +284,7 @@ private[pekko] sealed trait ExtendedBackoffOptions[T <: ExtendedBackoffOptions[T
    * @param supervisorStrategy the supervisorStrategy that the back-off supervisor will use.
    *                           The default supervisor strategy is used as fallback if the specified supervisorStrategy (its decider)
    *                           does not explicitly handle an exception. As the BackoffSupervisor creates a separate actor to handle the
-   *                           backoff process, only a [[OneForOneStrategy]] makes sense here.
+   *                           backoff process, only a `OneForOneStrategy` makes sense here.
    *                           Note that changing the strategy will replace the previously defined maxNrOfRetries.
    */
   def withSupervisorStrategy(supervisorStrategy: OneForOneStrategy): T

actor/src/main/scala/org/apache/pekko/pattern/BackoffSupervisor.scala

@@ -61,13 +61,13 @@ object BackoffSupervisor {
 
   /**
    * Send this message to the `BackoffSupervisor` and it will reset the back-off.
-   * This should be used in conjunction with `withManualReset` in [[BackoffOptions]].
+   * This should be used in conjunction with `withManualReset` in `BackoffOptions`.
    */
   case object Reset
 
   /**
    * Java API: Send this message to the `BackoffSupervisor` and it will reset the back-off.
-   * This should be used in conjunction with `withManualReset` in [[BackoffOptions]].
+   * This should be used in conjunction with `withManualReset` in `BackoffOptions`.
    */
   def reset = Reset
 

actor/src/main/scala/org/apache/pekko/pattern/CircuitBreaker.scala

@@ -64,7 +64,7 @@ object CircuitBreaker {
    * Create or find a CircuitBreaker in registry.
    *
    * @param id Circuit Breaker identifier
-   * @param system [[ExtendedActorSystem]] that is storing this [[CircuitBreaker]]
+   * @param system `ExtendedActorSystem` that is storing this [[CircuitBreaker]]
    */
   def apply(id: String)(implicit system: ExtendedActorSystem): CircuitBreaker =
     CircuitBreakersRegistry(system).get(id)
@@ -92,7 +92,7 @@ object CircuitBreaker {
    * Java API: Lookup a CircuitBreaker in registry.
    *
    * @param id Circuit Breaker identifier
-   * @param system [[ExtendedActorSystem]] that is storing this [[CircuitBreaker]]
+   * @param system `ExtendedActorSystem` that is storing this [[CircuitBreaker]]
    */
   def lookup(id: String, system: ExtendedActorSystem): CircuitBreaker =
     apply(id)(system)
@@ -330,7 +330,7 @@ class CircuitBreaker(
     currentState.invoke(body, failureFn)
 
   /**
-   * Java API for [[#withCircuitBreaker]].
+   * Java API for `withCircuitBreaker`.
    *
    * @param body Call needing protected
    * @return [[scala.concurrent.Future]] containing the call result or a
@@ -340,7 +340,7 @@ class CircuitBreaker(
     withCircuitBreaker(body.call)
 
   /**
-   * Java API for [[#withCircuitBreaker]].
+   * Java API for `withCircuitBreaker`.
    *
    * @param body Call needing protected
    * @param defineFailureFn function that define what should be consider failure and thus increase failure count
@@ -356,7 +356,7 @@ class CircuitBreaker(
   }
 
   /**
-   * Java API (8) for [[#withCircuitBreaker]].
+   * Java API (8) for `withCircuitBreaker`.
    *
    * @param body Call needing protected
    * @return [[java.util.concurrent.CompletionStage]] containing the call result or a
@@ -368,7 +368,7 @@ class CircuitBreaker(
     }).asJava
 
   /**
-   * Java API (8) for [[#withCircuitBreaker]].
+   * Java API (8) for `withCircuitBreaker`.
    *
    * @param body Call needing protected
    * @param defineFailureFn function that define what should be consider failure and thus increase failure count
@@ -419,7 +419,7 @@ class CircuitBreaker(
       callTimeout)
 
   /**
-   * Java API for [[#withSyncCircuitBreaker]]. Throws [[java.util.concurrent.TimeoutException]] if the call timed out.
+   * Java API for `withSyncCircuitBreaker`. Throws [[java.util.concurrent.TimeoutException]] if the call timed out.
    *
    * @param body Call needing protected
    * @return The result of the call
@@ -428,7 +428,7 @@ class CircuitBreaker(
     withSyncCircuitBreaker(body.call)
 
   /**
-   * Java API for [[#withSyncCircuitBreaker]]. Throws [[java.util.concurrent.TimeoutException]] if the call timed out.
+   * Java API for `withSyncCircuitBreaker`. Throws [[java.util.concurrent.TimeoutException]] if the call timed out.
    *
    * @param body Call needing protected
    * @param defineFailureFn function that define what should be consider failure and thus increase failure count
@@ -444,7 +444,7 @@ class CircuitBreaker(
   /**
    * Mark a successful call through CircuitBreaker. Sometimes the callee of CircuitBreaker sends back a message to the
    * caller Actor. In such a case, it is convenient to mark a successful call instead of using Future
-   * via [[withCircuitBreaker]]
+   * via `withCircuitBreaker`
    */
   def succeed(): Unit = {
     currentState.callSucceeds()
@@ -453,7 +453,7 @@ class CircuitBreaker(
   /**
    * Mark a failed call through CircuitBreaker. Sometimes the callee of CircuitBreaker sends back a message to the
    * caller Actor. In such a case, it is convenient to mark a failed call instead of using Future
-   * via [[withCircuitBreaker]]
+   * via `withCircuitBreaker`
    */
   def fail(): Unit = {
     currentState.callFails()

actor/src/main/scala/org/apache/pekko/pattern/FutureTimeoutSupport.scala

@@ -90,7 +90,7 @@ trait FutureTimeoutSupport {
     }
 
   /**
-   * Returns a [[scala.concurrent.Future]] that will be completed with a [[TimeoutException]]
+   * Returns a [[scala.concurrent.Future]] that will be completed with a `TimeoutException`
    * if the provided value is not completed within the specified duration.
    * @since 1.2.0
    */
@@ -122,7 +122,7 @@ trait FutureTimeoutSupport {
   }
 
   /**
-   * Returns a [[java.util.concurrent.CompletionStage]] that will be completed with a [[TimeoutException]]
+   * Returns a [[java.util.concurrent.CompletionStage]] that will be completed with a `TimeoutException`
    * if the provided value is not completed within the specified duration.
    * @since 1.2.0
    */