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-jdbc.git
The following commit(s) were added to refs/heads/main by this push:
new 6dda89c0 fix: fix scaladoc warnings in core module (#552)
6dda89c0 is described below
commit 6dda89c0bd927914c9e214ba1555370c3abedc4a
Author: He-Pin(kerr) <[email protected]>
AuthorDate: Mon Jul 6 10:17:22 2026 +0800
fix: fix scaladoc warnings in core module (#552)
Motivation:
Running `sbt doc` produces scaladoc warnings about unresolvable or
incorrect links.
Modification:
- db/SlickExtension.scala: Use fully qualified org.apache.pekko path for
ActorSystem link
- journal/dao/JournalDao.scala: Replace broken method link with
backtick-quoted code
- journal/dao/legacy/ByteArrayJournalDao.scala: Replace broken method link
with backtick-quoted code
- journal/JdbcAsyncWriteJournal.scala: Use fully qualified org.apache.pekko
path for Tagged link
- query/javadsl/JdbcReadJournal.scala: Use fully qualified path for
CurrentEventsByTagQuery link
- query/scaladsl/JdbcReadJournal.scala: Use fully qualified path for
CurrentEventsByTagQuery link
Result:
Scaladoc warnings are eliminated.
Tests:
Not run - docs only
References:
None
---
.../scala/org/apache/pekko/persistence/jdbc/db/SlickExtension.scala | 2 +-
.../apache/pekko/persistence/jdbc/journal/JdbcAsyncWriteJournal.scala | 2 +-
.../org/apache/pekko/persistence/jdbc/journal/dao/JournalDao.scala | 2 +-
.../pekko/persistence/jdbc/journal/dao/legacy/ByteArrayJournalDao.scala | 2 +-
.../apache/pekko/persistence/jdbc/query/javadsl/JdbcReadJournal.scala | 2 +-
.../apache/pekko/persistence/jdbc/query/scaladsl/JdbcReadJournal.scala | 2 +-
6 files changed, 6 insertions(+), 6 deletions(-)
diff --git
a/core/src/main/scala/org/apache/pekko/persistence/jdbc/db/SlickExtension.scala
b/core/src/main/scala/org/apache/pekko/persistence/jdbc/db/SlickExtension.scala
index 3a231e6f..1376e0ea 100644
---
a/core/src/main/scala/org/apache/pekko/persistence/jdbc/db/SlickExtension.scala
+++
b/core/src/main/scala/org/apache/pekko/persistence/jdbc/db/SlickExtension.scala
@@ -49,7 +49,7 @@ class SlickExtensionImpl(system: ExtendedActorSystem) extends
Extension {
* A SlickDatabaseProvider is loaded using reflection,
* The instance is created using the following:
* - The fully qualified class name as configured in
`jdbc-journal.database-provider-fqcn`.
- * - The constructor with one argument of type [[pekko.actor.ActorSystem]] is
used to create the instance.
+ * - The constructor with one argument of type
[[org.apache.pekko.actor.ActorSystem ActorSystem]] is used to create the
instance.
* Therefore the class must have such a constructor.
*/
trait SlickDatabaseProvider {
diff --git
a/core/src/main/scala/org/apache/pekko/persistence/jdbc/journal/JdbcAsyncWriteJournal.scala
b/core/src/main/scala/org/apache/pekko/persistence/jdbc/journal/JdbcAsyncWriteJournal.scala
index b5589f1e..d2da94ac 100644
---
a/core/src/main/scala/org/apache/pekko/persistence/jdbc/journal/JdbcAsyncWriteJournal.scala
+++
b/core/src/main/scala/org/apache/pekko/persistence/jdbc/journal/JdbcAsyncWriteJournal.scala
@@ -44,7 +44,7 @@ object JdbcAsyncWriteJournal {
* Extra Plugin API: May be used to issue in-place updates for events.
* To be used only for data migrations such as "encrypt all events" and
similar operations.
*
- * The write payload may be wrapped in a
[[pekko.persistence.journal.Tagged]],
+ * The write payload may be wrapped in a
[[org.apache.pekko.persistence.journal.Tagged Tagged]],
* in which case the new tags will overwrite the existing tags of the event.
*/
final case class InPlaceUpdateEvent(persistenceId: String, seqNr: Long,
write: AnyRef)
diff --git
a/core/src/main/scala/org/apache/pekko/persistence/jdbc/journal/dao/JournalDao.scala
b/core/src/main/scala/org/apache/pekko/persistence/jdbc/journal/dao/JournalDao.scala
index 5e19cd0e..d4a8e424 100644
---
a/core/src/main/scala/org/apache/pekko/persistence/jdbc/journal/dao/JournalDao.scala
+++
b/core/src/main/scala/org/apache/pekko/persistence/jdbc/journal/dao/JournalDao.scala
@@ -33,7 +33,7 @@ trait JournalDao extends JournalDaoWithReadMessages {
def highestSequenceNr(persistenceId: String, fromSequenceNr: Long):
Future[Long]
/**
- * @see
[[pekko.persistence.journal.AsyncWriteJournal.asyncWriteMessages(messages)]]
+ * @see
`org.apache.pekko.persistence.journal.AsyncWriteJournal.asyncWriteMessages(messages)`
*/
def asyncWriteMessages(messages: Seq[AtomicWrite]): Future[Seq[Try[Unit]]]
}
diff --git
a/core/src/main/scala/org/apache/pekko/persistence/jdbc/journal/dao/legacy/ByteArrayJournalDao.scala
b/core/src/main/scala/org/apache/pekko/persistence/jdbc/journal/dao/legacy/ByteArrayJournalDao.scala
index 29961c36..4ae1e300 100644
---
a/core/src/main/scala/org/apache/pekko/persistence/jdbc/journal/dao/legacy/ByteArrayJournalDao.scala
+++
b/core/src/main/scala/org/apache/pekko/persistence/jdbc/journal/dao/legacy/ByteArrayJournalDao.scala
@@ -67,7 +67,7 @@ trait BaseByteArrayJournalDao
}
/**
- * @see
[[pekko.persistence.journal.AsyncWriteJournal.asyncWriteMessages(messages)]]
+ * @see
`org.apache.pekko.persistence.journal.AsyncWriteJournal.asyncWriteMessages(messages)`
*/
def asyncWriteMessages(messages: Seq[AtomicWrite]): Future[Seq[Try[Unit]]] =
{
val serializedTries: Seq[Try[Seq[JournalRow]]] =
serializer.serialize(messages)
diff --git
a/core/src/main/scala/org/apache/pekko/persistence/jdbc/query/javadsl/JdbcReadJournal.scala
b/core/src/main/scala/org/apache/pekko/persistence/jdbc/query/javadsl/JdbcReadJournal.scala
index fea9dcc1..86094456 100644
---
a/core/src/main/scala/org/apache/pekko/persistence/jdbc/query/javadsl/JdbcReadJournal.scala
+++
b/core/src/main/scala/org/apache/pekko/persistence/jdbc/query/javadsl/JdbcReadJournal.scala
@@ -135,7 +135,7 @@ class JdbcReadJournal(journal: ScalaJdbcReadJournal)
* The stream is not completed when it reaches the end of the currently
stored events,
* but it continues to push new events when new events are persisted.
* Corresponding query that is completed when it reaches the end of the
currently
- * stored events is provided by
[[CurrentEventsByTagQuery#currentEventsByTag]].
+ * stored events is provided by
[[org.apache.pekko.persistence.query.javadsl.CurrentEventsByTagQuery#currentEventsByTag]].
*/
override def eventsByTag(tag: String, offset: Offset): Source[EventEnvelope,
NotUsed] =
journal.eventsByTag(tag, offset).asJava
diff --git
a/core/src/main/scala/org/apache/pekko/persistence/jdbc/query/scaladsl/JdbcReadJournal.scala
b/core/src/main/scala/org/apache/pekko/persistence/jdbc/query/scaladsl/JdbcReadJournal.scala
index 4a8c39ab..77a02314 100644
---
a/core/src/main/scala/org/apache/pekko/persistence/jdbc/query/scaladsl/JdbcReadJournal.scala
+++
b/core/src/main/scala/org/apache/pekko/persistence/jdbc/query/scaladsl/JdbcReadJournal.scala
@@ -326,7 +326,7 @@ class JdbcReadJournal(config: Config, configPath:
String)(implicit val system: E
* The stream is not completed when it reaches the end of the currently
stored events,
* but it continues to push new events when new events are persisted.
* Corresponding query that is completed when it reaches the end of the
currently
- * stored events is provided by
[[CurrentEventsByTagQuery#currentEventsByTag]].
+ * stored events is provided by
[[org.apache.pekko.persistence.query.scaladsl.CurrentEventsByTagQuery#currentEventsByTag]].
*/
override def eventsByTag(tag: String, offset: Offset): Source[EventEnvelope,
NotUsed] =
eventsByTag(tag, offset.value)
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
