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-projection.git
The following commit(s) were added to refs/heads/main by this push:
new 197bf5d9 fix: fix javadoc warning in ShoppingCart test example (#556)
197bf5d9 is described below
commit 197bf5d9b8f6859ed95adb5df91dce2cec0e207a
Author: He-Pin(kerr) <[email protected]>
AuthorDate: Mon Jul 6 22:25:23 2026 +0800
fix: fix javadoc warning in ShoppingCart test example (#556)
* fix: fix javadoc warning in ShoppingCart test example
Motivation:
Javadoc warning: `{@link Summary}` cannot be resolved because `Summary`
is an inner class of `ShoppingCart` and needs the enclosing class prefix.
Modification:
- Replace `{@link Summary}` with `{@link ShoppingCart.Summary}`
- Replace `{@link Confirmation}` with `{@link ShoppingCart.Confirmation}`
Result:
Javadoc warning is 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.
---
examples/src/test/java/jdocs/eventsourced/ShoppingCart.java | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
diff --git a/examples/src/test/java/jdocs/eventsourced/ShoppingCart.java
b/examples/src/test/java/jdocs/eventsourced/ShoppingCart.java
index f964e32b..3bfa5281 100644
--- a/examples/src/test/java/jdocs/eventsourced/ShoppingCart.java
+++ b/examples/src/test/java/jdocs/eventsourced/ShoppingCart.java
@@ -115,15 +115,15 @@ public class ShoppingCart
/**
* A command to get the current state of the shopping cart.
*
- * <p>The reply type is the {@link Summary}
+ * <p>The reply type is the {@link ShoppingCart.Summary}
*/
public record Get(ActorRef<Summary> replyTo) implements Command {}
/**
* A command to checkout the shopping cart.
*
- * <p>The reply type is the {@link Confirmation}, which will be returned
when the events have been
- * emitted.
+ * <p>The reply type is the {@link ShoppingCart.Confirmation}, which will be
returned when the
+ * events have been emitted.
*/
public record Checkout(ActorRef<Confirmation> replyTo) implements Command {}
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
