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-grpc.git
The following commit(s) were added to refs/heads/main by this push:
new 3729e127 fix: fix scaladoc warnings in runtime module (#776)
3729e127 is described below
commit 3729e1277d1622dba6b75232030f89d65fd8078c
Author: He-Pin(kerr) <[email protected]>
AuthorDate: Tue Jul 7 02:11:48 2026 +0800
fix: fix scaladoc warnings in runtime module (#776)
Motivation:
The runtime module had 8 scaladoc warnings about unresolvable links
for external types and types with incorrect package prefixes.
Modification:
- Replace [[io.grpc.StatusException]] with backtick-quoted code (external
type)
- Replace [[Failure]] with backtick-quoted code (scala.util.Failure
external type)
- Replace [[Chunk]] and [[LastChunk]] with backtick-quoted code (pekko-http
types)
- Replace [[pekko.japi.function.Function]] with backtick-quoted code (wrong
prefix)
- Replace [[pekko.grpc.GrpcChannel]] with backtick-quoted code (wrong
prefix)
Result:
All 8 scaladoc warnings in the runtime module are resolved.
`sbt runtime/doc` completes with no warnings.
Tests:
Verified with `sbt runtime/clean; runtime/doc` - 0 warnings.
---
runtime/src/main/scala/org/apache/pekko/grpc/internal/Codec.scala | 2 +-
runtime/src/main/scala/org/apache/pekko/grpc/internal/Codecs.scala | 4 ++--
.../scala/org/apache/pekko/grpc/internal/GrpcProtocolNative.scala | 4 ++--
.../main/scala/org/apache/pekko/grpc/internal/GrpcProtocolWeb.scala | 4 ++--
runtime/src/main/scala/org/apache/pekko/grpc/javadsl/package.scala | 4 ++--
.../main/scala/org/apache/pekko/grpc/scaladsl/PekkoGrpcClient.scala | 2 +-
6 files changed, 10 insertions(+), 10 deletions(-)
diff --git a/runtime/src/main/scala/org/apache/pekko/grpc/internal/Codec.scala
b/runtime/src/main/scala/org/apache/pekko/grpc/internal/Codec.scala
index 24b31a8f..b01d2403 100644
--- a/runtime/src/main/scala/org/apache/pekko/grpc/internal/Codec.scala
+++ b/runtime/src/main/scala/org/apache/pekko/grpc/internal/Codec.scala
@@ -23,7 +23,7 @@ abstract class Codec {
/**
* Process the given frame bytes, uncompress if the compression bit is set.
Identity
- * codec will fail with a [[io.grpc.StatusException]] if the compressedBit
is set.
+ * codec will fail with a `io.grpc.StatusException` if the compressedBit is
set.
*/
def uncompress(compressedBitSet: Boolean, bytes: ByteString): ByteString
diff --git a/runtime/src/main/scala/org/apache/pekko/grpc/internal/Codecs.scala
b/runtime/src/main/scala/org/apache/pekko/grpc/internal/Codecs.scala
index 6dfbd357..5174562e 100644
--- a/runtime/src/main/scala/org/apache/pekko/grpc/internal/Codecs.scala
+++ b/runtime/src/main/scala/org/apache/pekko/grpc/internal/Codecs.scala
@@ -59,7 +59,7 @@ object Codecs {
* Determines the `Message-Encoding` specified in a message.
*
* @param message the gRPC message
- * @return the specified codec to uncompress data frame bodies with,
[[Identity]] if no encoding was specified, or [[Failure]] if an unsupported
encoding was specified.
+ * @return the specified codec to uncompress data frame bodies with,
[[Identity]] if no encoding was specified, or `Failure` if an unsupported
encoding was specified.
*/
def detect(message: jm.HttpMessage): Try[Codec] =
detect(`Message-Encoding`.findIn(extractHeaders(message)))
@@ -68,7 +68,7 @@ object Codecs {
* Determines the `Message-Encoding` specified in a gRPC stream to be
unmarshalled.
*
* @param encoding the specified message encoding.
- * @return the specified codec to uncompress data frame bodies with,
[[Identity]] if no encoding was specified, or [[Failure]] if an unsupported
encoding was specified.
+ * @return the specified codec to uncompress data frame bodies with,
[[Identity]] if no encoding was specified, or `Failure` if an unsupported
encoding was specified.
*/
def detect(encoding: Option[String]): Try[Codec] =
encoding
diff --git
a/runtime/src/main/scala/org/apache/pekko/grpc/internal/GrpcProtocolNative.scala
b/runtime/src/main/scala/org/apache/pekko/grpc/internal/GrpcProtocolNative.scala
index c7f13ff7..4338f937 100644
---
a/runtime/src/main/scala/org/apache/pekko/grpc/internal/GrpcProtocolNative.scala
+++
b/runtime/src/main/scala/org/apache/pekko/grpc/internal/GrpcProtocolNative.scala
@@ -35,8 +35,8 @@ import scala.collection.immutable
* Implementation of the gRPC (`application/grpc+proto`) protocol:
*
* Protocol:
- * - Data frames are encoded to a stream of [[Chunk]] as per the gRPC
specification
- * - Trailer frames are encoded to [[LastChunk]], to be rendered into the
underlying HTTP/2 transport
+ * - Data frames are encoded to a stream of `Chunk` as per the gRPC
specification
+ * - Trailer frames are encoded to `LastChunk`, to be rendered into the
underlying HTTP/2 transport
*/
object GrpcProtocolNative extends AbstractGrpcProtocol("grpc") {
diff --git
a/runtime/src/main/scala/org/apache/pekko/grpc/internal/GrpcProtocolWeb.scala
b/runtime/src/main/scala/org/apache/pekko/grpc/internal/GrpcProtocolWeb.scala
index 9519e1d5..1995b711 100644
---
a/runtime/src/main/scala/org/apache/pekko/grpc/internal/GrpcProtocolWeb.scala
+++
b/runtime/src/main/scala/org/apache/pekko/grpc/internal/GrpcProtocolWeb.scala
@@ -88,8 +88,8 @@ abstract class GrpcProtocolWebBase(subType: String) extends
AbstractGrpcProtocol
* Implementation of the gRPC Web protocol.
*
* Protocol:
- * - Data frames are encoded to a stream of [[Chunk]] as per the gRPC-web
specification.
- * - Trailer frames are encoded to a [[Chunk]] (containing a marked trailer
frame) as per the gRPC-web specification.
+ * - Data frames are encoded to a stream of `Chunk` as per the gRPC-web
specification.
+ * - Trailer frames are encoded to a `Chunk` (containing a marked trailer
frame) as per the gRPC-web specification.
*/
object GrpcProtocolWeb extends GrpcProtocolWebBase("grpc-web") {
diff --git a/runtime/src/main/scala/org/apache/pekko/grpc/javadsl/package.scala
b/runtime/src/main/scala/org/apache/pekko/grpc/javadsl/package.scala
index 379ed6ca..90a1591f 100644
--- a/runtime/src/main/scala/org/apache/pekko/grpc/javadsl/package.scala
+++ b/runtime/src/main/scala/org/apache/pekko/grpc/javadsl/package.scala
@@ -20,7 +20,7 @@ import org.apache.pekko
package object javadsl {
/**
- * Helper for creating Scala partial functions from
[[pekko.japi.function.Function]]
+ * Helper for creating Scala partial functions from
`pekko.japi.function.Function`
* instances.
*/
@deprecated("no longer needed since support for Scala 2.11 has been
dropped", "1.2.0")
@@ -29,7 +29,7 @@ package object javadsl {
}
/**
- * Helper for creating Scala anonymous partial functions from
[[pekko.japi.function.Function]]
+ * Helper for creating Scala anonymous partial functions from
`pekko.japi.function.Function`
* instances.
*/
@nowarn("msg=deprecated")
diff --git
a/runtime/src/main/scala/org/apache/pekko/grpc/scaladsl/PekkoGrpcClient.scala
b/runtime/src/main/scala/org/apache/pekko/grpc/scaladsl/PekkoGrpcClient.scala
index 2d1f530a..5d521080 100644
---
a/runtime/src/main/scala/org/apache/pekko/grpc/scaladsl/PekkoGrpcClient.scala
+++
b/runtime/src/main/scala/org/apache/pekko/grpc/scaladsl/PekkoGrpcClient.scala
@@ -29,7 +29,7 @@ trait PekkoGrpcClient {
* This method is only valid for clients that use an internal channel. If
the client was created
* with a shared user-provided channel, the channel itself should be closed.
*
- * @throws org.apache.pekko.grpc.GrpcClientCloseException if client was
created with a user-provided [[pekko.grpc.GrpcChannel]].
+ * @throws org.apache.pekko.grpc.GrpcClientCloseException if client was
created with a user-provided `pekko.grpc.GrpcChannel`.
*/
def close(): Future[Done]
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
