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-connectors-kafka.git
The following commit(s) were added to refs/heads/main by this push:
new f33eb023 fix: fix javadoc warnings in testkit Java sources (#585)
f33eb023 is described below
commit f33eb023640c4916167a941559d248f57a50fbf9
Author: He-Pin(kerr) <[email protected]>
AuthorDate: Sun Jul 5 03:14:53 2026 +0800
fix: fix javadoc warnings in testkit Java sources (#585)
* fix: fix javadoc warnings in testkit Java sources
Motivation:
Running `sbt doc` produces javadoc warnings in Java source files:
- Scala-style `[[...]]` links are not recognized by javadoc
Modification:
- TestcontainersKafkaTest.java: Replace Scala-style link with HTML anchor
- TestcontainersKafkaJunit4Test.java: Replace Scala-style link with HTML
anchor
- BaseKafkaTest.java: Replace Scala-style method reference with `{@code
resultOf}`
Result:
Javadoc warnings are eliminated.
Tests:
Not run - docs only
References:
None
* 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.
---
.../apache/pekko/kafka/testkit/TestcontainersKafkaJunit4Test.java | 6 +++---
.../org/apache/pekko/kafka/testkit/TestcontainersKafkaTest.java | 6 +++---
.../java/org/apache/pekko/kafka/testkit/javadsl/BaseKafkaTest.java | 5 +----
3 files changed, 7 insertions(+), 10 deletions(-)
diff --git
a/testkit/src/main/java/org/apache/pekko/kafka/testkit/TestcontainersKafkaJunit4Test.java
b/testkit/src/main/java/org/apache/pekko/kafka/testkit/TestcontainersKafkaJunit4Test.java
index e73ea42c..091e65bc 100644
---
a/testkit/src/main/java/org/apache/pekko/kafka/testkit/TestcontainersKafkaJunit4Test.java
+++
b/testkit/src/main/java/org/apache/pekko/kafka/testkit/TestcontainersKafkaJunit4Test.java
@@ -22,9 +22,9 @@ import org.junit.After;
import org.junit.Before;
/**
- * JUnit 4 base class using [[https://www.testcontainers.org/ Testcontainers]]
to start a Kafka
- * broker in a Docker container. The Kafka broker will be kept around across
multiple test classes,
- * unless `stopKafka()` is called.
+ * JUnit 4 base class using <a
href="https://www.testcontainers.org/";>Testcontainers</a> to start a
+ * Kafka broker in a Docker container. The Kafka broker will be kept around
across multiple test
+ * classes, unless `stopKafka()` is called.
*
* <p>The Testcontainers dependency has to be added explicitly.
*
diff --git
a/testkit/src/main/java/org/apache/pekko/kafka/testkit/TestcontainersKafkaTest.java
b/testkit/src/main/java/org/apache/pekko/kafka/testkit/TestcontainersKafkaTest.java
index 965a4ad3..e3792662 100644
---
a/testkit/src/main/java/org/apache/pekko/kafka/testkit/TestcontainersKafkaTest.java
+++
b/testkit/src/main/java/org/apache/pekko/kafka/testkit/TestcontainersKafkaTest.java
@@ -19,9 +19,9 @@ import org.apache.pekko.actor.ClassicActorSystemProvider;
import org.apache.pekko.kafka.testkit.internal.TestcontainersKafka;
/**
- * JUnit 5 base class using [[https://www.testcontainers.org/ Testcontainers]]
to start a Kafka
- * broker in a Docker container. The Kafka broker will be kept around across
multiple test classes,
- * unless `stopKafka()` is called (eg. from an `@AfterAll`-annotated method.
+ * JUnit 5 base class using <a
href="https://www.testcontainers.org/";>Testcontainers</a> to start a
+ * Kafka broker in a Docker container. The Kafka broker will be kept around
across multiple test
+ * classes, unless `stopKafka()` is called (eg. from an `@AfterAll`-annotated
method.
*
* <p>Extending classes must be annotated with
`@TestInstance(Lifecycle.PER_CLASS)` to create a
* single instance of the test class with `@BeforeAll` and `@AfterAll`
annotated methods called by
diff --git
a/testkit/src/main/java/org/apache/pekko/kafka/testkit/javadsl/BaseKafkaTest.java
b/testkit/src/main/java/org/apache/pekko/kafka/testkit/javadsl/BaseKafkaTest.java
index 3cf9faab..19033a57 100644
---
a/testkit/src/main/java/org/apache/pekko/kafka/testkit/javadsl/BaseKafkaTest.java
+++
b/testkit/src/main/java/org/apache/pekko/kafka/testkit/javadsl/BaseKafkaTest.java
@@ -62,10 +62,7 @@ public abstract class BaseKafkaTest extends
KafkaTestKitClass {
return log;
}
- /**
- * Overwrite to set different default timeout for
- * [[resultOf[T](stage:java\.util\.concurrent\.CompletionStage[T])*
resultOf]].
- */
+ /** Overwrite to set different default timeout for {@code resultOf}. */
protected Duration resultOfTimeout() {
return Duration.ofSeconds(5);
}
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
