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-persistence-dynamodb.git
The following commit(s) were added to refs/heads/main by this push:
new c6c6613 fix: fix scaladoc warnings in query module (#330)
c6c6613 is described below
commit c6c6613d7e42b0efc86592332d5b3333d718c04b
Author: He-Pin(kerr) <[email protected]>
AuthorDate: Mon Jul 6 19:51:18 2026 +0800
fix: fix scaladoc warnings in query module (#330)
Motivation:
Running `sbt doc` produces scaladoc warnings about unresolvable method
links.
Modification:
- query/javadsl/DynamoDBReadJournal.scala: Replace broken method links with
backtick-quoted code
- query/scaladsl/DynamoDBCurrentEventsByPersistenceIdQuery.scala: Replace
broken method link with backtick-quoted code
- query/scaladsl/DynamoDBCurrentPersistenceIdsQuery.scala: Replace broken
method link with backtick-quoted code
- query/scaladsl/internal/DynamoDBCurrentEventsByPersistenceIdQuery.scala:
Replace broken method link with backtick-quoted code
- query/scaladsl/internal/DynamoDBCurrentPersistenceIdsQuery.scala: Replace
broken method link with backtick-quoted code
Result:
Scaladoc warnings are eliminated.
Tests:
Not run - docs only
References:
None
---
.../persistence/dynamodb/query/javadsl/DynamoDBReadJournal.scala | 4 ++--
.../query/scaladsl/DynamoDBCurrentEventsByPersistenceIdQuery.scala | 2 +-
.../dynamodb/query/scaladsl/DynamoDBCurrentPersistenceIdsQuery.scala | 2 +-
.../scaladsl/internal/DynamoDBCurrentEventsByPersistenceIdQuery.scala | 2 +-
.../query/scaladsl/internal/DynamoDBCurrentPersistenceIdsQuery.scala | 2 +-
5 files changed, 6 insertions(+), 6 deletions(-)
diff --git
a/src/main/scala/org/apache/pekko/persistence/dynamodb/query/javadsl/DynamoDBReadJournal.scala
b/src/main/scala/org/apache/pekko/persistence/dynamodb/query/javadsl/DynamoDBReadJournal.scala
index a4ca0f4..8496b0b 100644
---
a/src/main/scala/org/apache/pekko/persistence/dynamodb/query/javadsl/DynamoDBReadJournal.scala
+++
b/src/main/scala/org/apache/pekko/persistence/dynamodb/query/javadsl/DynamoDBReadJournal.scala
@@ -51,7 +51,7 @@ class DynamoDBReadJournal(scaladslReadJournal:
scaladsl.DynamoDBReadJournal)
{
/**
- * Same type of query as
[[org.apache.pekko.persistence.query.javadsl.EventsByPersistenceIdQuery.eventsByPersistenceId]]
+ * Same type of query as
`org.apache.pekko.persistence.query.javadsl.EventsByPersistenceIdQuery.eventsByPersistenceId`
* but the event stream is completed immediately when it reaches the end of
* the results. Events that are stored after the query is completed are
* not included in the event stream.
@@ -67,7 +67,7 @@ class DynamoDBReadJournal(scaladslReadJournal:
scaladsl.DynamoDBReadJournal)
scaladslReadJournal.currentEventsByPersistenceId(persistenceId,
fromSequenceNr, toSequenceNr).asJava
/**
- * Same type of query as
[[org.apache.pekko.persistence.query.javadsl.PersistenceIdsQuery.persistenceIds()]]
but the stream
+ * Same type of query as
`org.apache.pekko.persistence.query.javadsl.PersistenceIdsQuery.persistenceIds()`
but the stream
* is completed immediately when it reaches the end of the "result set".
Persistent
* actors that are created after the query is completed are not included in
the stream.
*
diff --git
a/src/main/scala/org/apache/pekko/persistence/dynamodb/query/scaladsl/DynamoDBCurrentEventsByPersistenceIdQuery.scala
b/src/main/scala/org/apache/pekko/persistence/dynamodb/query/scaladsl/DynamoDBCurrentEventsByPersistenceIdQuery.scala
index a372f53..3486a8b 100644
---
a/src/main/scala/org/apache/pekko/persistence/dynamodb/query/scaladsl/DynamoDBCurrentEventsByPersistenceIdQuery.scala
+++
b/src/main/scala/org/apache/pekko/persistence/dynamodb/query/scaladsl/DynamoDBCurrentEventsByPersistenceIdQuery.scala
@@ -17,7 +17,7 @@ import org.apache.pekko.stream.scaladsl.Source
trait DynamoDBCurrentEventsByPersistenceIdQuery extends
CurrentEventsByPersistenceIdQuery {
/**
- * Same type of query as
[[org.apache.pekko.persistence.query.scaladsl.EventsByPersistenceIdQuery.eventsByPersistenceId]]
+ * Same type of query as
`org.apache.pekko.persistence.query.scaladsl.EventsByPersistenceIdQuery.eventsByPersistenceId`
* but the event stream is completed immediately when it reaches the end of
* the results. Events that are stored after the query is completed are
* not included in the event stream.
diff --git
a/src/main/scala/org/apache/pekko/persistence/dynamodb/query/scaladsl/DynamoDBCurrentPersistenceIdsQuery.scala
b/src/main/scala/org/apache/pekko/persistence/dynamodb/query/scaladsl/DynamoDBCurrentPersistenceIdsQuery.scala
index 2ce06b6..19f3120 100644
---
a/src/main/scala/org/apache/pekko/persistence/dynamodb/query/scaladsl/DynamoDBCurrentPersistenceIdsQuery.scala
+++
b/src/main/scala/org/apache/pekko/persistence/dynamodb/query/scaladsl/DynamoDBCurrentPersistenceIdsQuery.scala
@@ -22,7 +22,7 @@ import scala.concurrent.Future
trait DynamoDBCurrentPersistenceIdsQuery extends CurrentPersistenceIdsQuery {
/**
- * Same type of query as
[[org.apache.pekko.persistence.query.scaladsl.PersistenceIdsQuery.persistenceIds()]]
but the stream
+ * Same type of query as
`org.apache.pekko.persistence.query.scaladsl.PersistenceIdsQuery.persistenceIds()`
but the stream
* is completed immediately when it reaches the end of the "result set".
Persistent
* actors that are created after the query is completed are not included in
the stream.
*
diff --git
a/src/main/scala/org/apache/pekko/persistence/dynamodb/query/scaladsl/internal/DynamoDBCurrentEventsByPersistenceIdQuery.scala
b/src/main/scala/org/apache/pekko/persistence/dynamodb/query/scaladsl/internal/DynamoDBCurrentEventsByPersistenceIdQuery.scala
index ba55532..522cb2b 100644
---
a/src/main/scala/org/apache/pekko/persistence/dynamodb/query/scaladsl/internal/DynamoDBCurrentEventsByPersistenceIdQuery.scala
+++
b/src/main/scala/org/apache/pekko/persistence/dynamodb/query/scaladsl/internal/DynamoDBCurrentEventsByPersistenceIdQuery.scala
@@ -40,7 +40,7 @@ trait DynamoDBCurrentEventsByPersistenceIdQuery
with SerializationProvider =>
/**
- * Same type of query as
[[org.apache.pekko.persistence.query.scaladsl.EventsByPersistenceIdQuery.eventsByPersistenceId]]
+ * Same type of query as
`org.apache.pekko.persistence.query.scaladsl.EventsByPersistenceIdQuery.eventsByPersistenceId`
* but the event stream is completed immediately when it reaches the end of
* the results. Events that are stored after the query is completed are
* not included in the event stream.
diff --git
a/src/main/scala/org/apache/pekko/persistence/dynamodb/query/scaladsl/internal/DynamoDBCurrentPersistenceIdsQuery.scala
b/src/main/scala/org/apache/pekko/persistence/dynamodb/query/scaladsl/internal/DynamoDBCurrentPersistenceIdsQuery.scala
index d934b6d..a32131c 100644
---
a/src/main/scala/org/apache/pekko/persistence/dynamodb/query/scaladsl/internal/DynamoDBCurrentPersistenceIdsQuery.scala
+++
b/src/main/scala/org/apache/pekko/persistence/dynamodb/query/scaladsl/internal/DynamoDBCurrentPersistenceIdsQuery.scala
@@ -39,7 +39,7 @@ trait DynamoDBCurrentPersistenceIdsQuery extends
PublicDynamoDBCurrentPersistenc
with JournalKeys =>
/**
- * Same type of query as
[[org.apache.pekko.persistence.query.scaladsl.PersistenceIdsQuery.persistenceIds()]]
but the stream
+ * Same type of query as
`org.apache.pekko.persistence.query.scaladsl.PersistenceIdsQuery.persistenceIds()`
but the stream
* is completed immediately when it reaches the end of the "result set".
Persistent
* actors that are created after the query is completed are not included in
the stream.
*
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
