This is an automated email from the ASF dual-hosted git repository.
He-Pin 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 e6d1533a72 Fix a few broken Scaladoc links reported by unidoc #353
(#3120)
e6d1533a72 is described below
commit e6d1533a72519b0b6d2d52a8fd67bd2fd1ef82a3
Author: Henri Cook <[email protected]>
AuthorDate: Mon Jun 22 13:50:08 2026 +0100
Fix a few broken Scaladoc links reported by unidoc #353 (#3120)
Motivation:
sbt unidoc reports many "Could not find any member to link for" warnings
(#353). A few are simply broken links rather than the trickier private or
ambiguous-target cases: Tcp's SimpleWriteCommand and CompoundWrite still
link
[[WriteFile]], but that command was renamed to WritePath; and
ShardingEnvelope's
@throws tag wraps the exception type in [[ ]], which Scaladoc does not
parse for
@throws.
Modification:
- Tcp.scala: [[WriteFile]] -> [[WritePath]] in two Scaladoc comments.
- ShardingMessageExtractor.scala: drop the [[ ]] from the @throws tag so it
follows the "@throws <fully.qualified.type> <description>" form used
elsewhere.
Result:
Three unidoc link warnings are resolved. No API or behaviour change.
Tests:
Not run - docs only. Verified with sbt unidoc that the three warnings are
gone
and no new warnings appear; sbt scalafmtCheck passes for the two modules.
References:
Refs #353
---
actor/src/main/scala/org/apache/pekko/io/Tcp.scala | 4 ++--
.../pekko/cluster/sharding/typed/ShardingMessageExtractor.scala | 2 +-
2 files changed, 3 insertions(+), 3 deletions(-)
diff --git a/actor/src/main/scala/org/apache/pekko/io/Tcp.scala
b/actor/src/main/scala/org/apache/pekko/io/Tcp.scala
index 70d7ced59c..97641f90ce 100644
--- a/actor/src/main/scala/org/apache/pekko/io/Tcp.scala
+++ b/actor/src/main/scala/org/apache/pekko/io/Tcp.scala
@@ -316,7 +316,7 @@ object Tcp extends ExtensionId[TcpExt] with
ExtensionIdProvider {
}
/**
- * Common supertype of [[Write]] and [[WriteFile]].
+ * Common supertype of [[Write]] and [[WritePath]].
*/
sealed abstract class SimpleWriteCommand extends WriteCommand {
require(ack != null, "ack must be non-null. Use NoAck if you don't want
acks.")
@@ -383,7 +383,7 @@ object Tcp extends ExtensionId[TcpExt] with
ExtensionIdProvider {
/**
* A write command which aggregates two other write commands. Using this
construct
- * you can chain a number of [[Write]] and/or [[WriteFile]] commands
together in a way
+ * you can chain a number of [[Write]] and/or [[WritePath]] commands
together in a way
* that allows them to be handled as a single write which gets written out
to the
* network as quickly as possible.
* If the sub commands contain `ack` requests they will be honored as soon
as the
diff --git
a/cluster-sharding-typed/src/main/scala/org/apache/pekko/cluster/sharding/typed/ShardingMessageExtractor.scala
b/cluster-sharding-typed/src/main/scala/org/apache/pekko/cluster/sharding/typed/ShardingMessageExtractor.scala
index 3f0f4ced92..15f8ac4597 100644
---
a/cluster-sharding-typed/src/main/scala/org/apache/pekko/cluster/sharding/typed/ShardingMessageExtractor.scala
+++
b/cluster-sharding-typed/src/main/scala/org/apache/pekko/cluster/sharding/typed/ShardingMessageExtractor.scala
@@ -120,7 +120,7 @@ abstract class HashCodeNoEnvelopeMessageExtractor[M](val
numberOfShards: Int) ex
*
* @param entityId The business domain identifier of the entity.
* @param message The message to be send to the entity.
- * @throws [[pekko.actor.InvalidMessageException]] if message is null.
+ * @throws pekko.actor.InvalidMessageException if message is null.
*/
final case class ShardingEnvelope[M](entityId: String, message: M)
extends WrappedMessage
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
