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 bbaa2df1 fix: fix javadoc warning in JavaTestServiceImpl.java (#775)
bbaa2df1 is described below
commit bbaa2df120d0cd1cc947d9d9a35a591e6a2c0270
Author: He-Pin(kerr) <[email protected]>
AuthorDate: Sun Jul 5 06:14:17 2026 +0800
fix: fix javadoc warning in JavaTestServiceImpl.java (#775)
* fix: fix javadoc warning in JavaTestServiceImpl.java
Motivation:
Running `sbt doc` produces a javadoc warning:
- Scala-style `[[...]]` link is not recognized by javadoc
Modification:
- Replace `[[io.grpc.testing.integration.TestServiceImpl]]` with
`{@code io.grpc.testing.integration.TestServiceImpl}`
Result:
Javadoc warning is eliminated.
Tests:
Not run - docs only
References:
None
* fix: fix additional javadoc warnings in Java sources
Motivation:
Additional javadoc warnings found in Java source files:
- Scala-style `[[...]]` links in interop test files
- Unqualified `@throws IllegalArgumentException` in benchmark files
Modification:
- JavaTestServiceImpl.java (interop-tests): Replace `[[...]]` with `{@code}`
- PekkoGrpcJavaClientTester.java: Replace `[[...]]` with `{@code}`
- Transport.java, ServerConfiguration.java, Configuration.java:
Use fully qualified `java.lang.IllegalArgumentException` in @throws
Result:
Remaining javadoc warnings in Java sources are eliminated.
Tests:
Not run - docs only
References:
Follow-up to #775
* style: apply javafmt to javadoc PR files
Motivation:
CI javafmtCheck fails on the javadoc warnings PR due to unformatted Java
files.
Modification:
Run sbt javafmt to auto-format all Java source files.
Result:
CI javafmtCheck should now pass.
---
.../src/main/java/org/apache/pekko/grpc/benchmarks/Transport.java | 2 +-
.../main/java/org/apache/pekko/grpc/benchmarks/qps/Configuration.java | 2 +-
.../org/apache/pekko/grpc/benchmarks/qps/ServerConfiguration.java | 2 +-
.../test/java/org/apache/pekko/grpc/interop/JavaTestServiceImpl.java | 2 +-
.../java/org/apache/pekko/grpc/interop/PekkoGrpcJavaClientTester.java | 4 ++--
.../src/main/java/org/apache/pekko/grpc/JavaTestServiceImpl.java | 2 +-
6 files changed, 7 insertions(+), 7 deletions(-)
diff --git
a/benchmark-java/src/main/java/org/apache/pekko/grpc/benchmarks/Transport.java
b/benchmark-java/src/main/java/org/apache/pekko/grpc/benchmarks/Transport.java
index ddfdc392..0c217e8a 100644
---
a/benchmark-java/src/main/java/org/apache/pekko/grpc/benchmarks/Transport.java
+++
b/benchmark-java/src/main/java/org/apache/pekko/grpc/benchmarks/Transport.java
@@ -39,7 +39,7 @@ public enum Transport {
/**
* Validates the given address for this transport.
*
- * @throws IllegalArgumentException if the given address is invalid for this
transport.
+ * @throws java.lang.IllegalArgumentException if the given address is
invalid for this transport.
*/
public void validateSocketAddress(SocketAddress address) {
if (!socketAddressValidator.isValidSocketAddress(address)) {
diff --git
a/benchmark-java/src/main/java/org/apache/pekko/grpc/benchmarks/qps/Configuration.java
b/benchmark-java/src/main/java/org/apache/pekko/grpc/benchmarks/qps/Configuration.java
index 060f52e0..69e473b6 100644
---
a/benchmark-java/src/main/java/org/apache/pekko/grpc/benchmarks/qps/Configuration.java
+++
b/benchmark-java/src/main/java/org/apache/pekko/grpc/benchmarks/qps/Configuration.java
@@ -28,7 +28,7 @@ public interface Configuration {
interface Builder<T extends Configuration> {
/**
* Builds the {@link Configuration} from the given command-line arguments.
- * @throws IllegalArgumentException if unable to build the configuration
for any reason.
+ * @throws java.lang.IllegalArgumentException if unable to build the
configuration for any reason.
*/
T build(String[] args);
diff --git
a/benchmark-java/src/main/java/org/apache/pekko/grpc/benchmarks/qps/ServerConfiguration.java
b/benchmark-java/src/main/java/org/apache/pekko/grpc/benchmarks/qps/ServerConfiguration.java
index 13d2d31f..43ca85dd 100644
---
a/benchmark-java/src/main/java/org/apache/pekko/grpc/benchmarks/qps/ServerConfiguration.java
+++
b/benchmark-java/src/main/java/org/apache/pekko/grpc/benchmarks/qps/ServerConfiguration.java
@@ -97,7 +97,7 @@ class ServerConfiguration implements Configuration {
/**
* Validates the given address for this transport.
*
- * @throws IllegalArgumentException if the given address is invalid for
this transport.
+ * @throws java.lang.IllegalArgumentException if the given address is
invalid for this transport.
*/
void validateSocketAddress(SocketAddress address) {
if (!socketAddressValidator.isValidSocketAddress(address)) {
diff --git
a/interop-tests/src/test/java/org/apache/pekko/grpc/interop/JavaTestServiceImpl.java
b/interop-tests/src/test/java/org/apache/pekko/grpc/interop/JavaTestServiceImpl.java
index 4f32937f..7bd40e38 100644
---
a/interop-tests/src/test/java/org/apache/pekko/grpc/interop/JavaTestServiceImpl.java
+++
b/interop-tests/src/test/java/org/apache/pekko/grpc/interop/JavaTestServiceImpl.java
@@ -32,7 +32,7 @@ import io.grpc.testing.integration.TestService;
/**
* Implementation of the generated service.
*
- * <p>Essentially porting the client code from
[[io.grpc.testing.integration.TestServiceImpl]]
+ * <p>Essentially porting the client code from {@code
io.grpc.testing.integration.TestServiceImpl}
* against our API's
*
* <p>The same implementation is also be found as part of the 'scripted' tests
at
diff --git
a/interop-tests/src/test/java/org/apache/pekko/grpc/interop/PekkoGrpcJavaClientTester.java
b/interop-tests/src/test/java/org/apache/pekko/grpc/interop/PekkoGrpcJavaClientTester.java
index 168e688d..fdcb9ef1 100644
---
a/interop-tests/src/test/java/org/apache/pekko/grpc/interop/PekkoGrpcJavaClientTester.java
+++
b/interop-tests/src/test/java/org/apache/pekko/grpc/interop/PekkoGrpcJavaClientTester.java
@@ -55,8 +55,8 @@ import scala.concurrent.ExecutionContext;
* ClientTester implementation that uses the generated pekko-grpc Java client
to exercise a server
* under test.
*
- * <p>Essentially porting the client code from
[[io.grpc.testing.integration.AbstractInteropTest]]
- * against our Scala API's
+ * <p>Essentially porting the client code from {@code
+ * io.grpc.testing.integration.AbstractInteropTest} against our Scala API's
*/
public class PekkoGrpcJavaClientTester implements ClientTester {
diff --git
a/sbt-plugin/src/sbt-test/gen-scala-server/00-interop/src/main/java/org/apache/pekko/grpc/JavaTestServiceImpl.java
b/sbt-plugin/src/sbt-test/gen-scala-server/00-interop/src/main/java/org/apache/pekko/grpc/JavaTestServiceImpl.java
index e6c9978e..c8ee88b9 100644
---
a/sbt-plugin/src/sbt-test/gen-scala-server/00-interop/src/main/java/org/apache/pekko/grpc/JavaTestServiceImpl.java
+++
b/sbt-plugin/src/sbt-test/gen-scala-server/00-interop/src/main/java/org/apache/pekko/grpc/JavaTestServiceImpl.java
@@ -29,7 +29,7 @@ import io.grpc.testing.integration.TestService;
/**
* Implementation of the generated service.
*
- * Essentially porting the client code from
[[io.grpc.testing.integration.TestServiceImpl]] against our API's
+ * Essentially porting the client code from {@code
io.grpc.testing.integration.TestServiceImpl} against our API's
*
* The same implementation is also be found as part of the 'non-scripted'
tests at
*
/interop-tests/src/test/java/org/apache/pekko/grpc/interop/JavaTestServiceImpl.scala
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
