raboof/pekko
1
0
Fork 0
Code Issues Pull requests Projects Releases 6 Packages Wiki Activity Actions 10

add external javadoc links (#353) (#674)

Browse source 
Co-authored-by: Naoki Yamada <yamada.naoki@tis.co.jp>
This commit is contained in:
Naoki Yamada 2023-09-24 03:08:15 +09:00 • committed by GitHub
parent 57401818bc
commit b7a5f673a9
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 19 additions and 8 deletions
Download patch file Download diff file Expand all files Collapse all files

8
persistence/src/main/scala/org/apache/pekko/persistence/Persistence.scala
View file

@ -128,9 +128,9 @@ trait RuntimePluginConfig {
/**
* Additional configuration of the journal plugin servicing this persistent actor.
* When empty, the whole configuration of the journal plugin will be taken from the [[Config]] loaded into the
* When empty, the whole configuration of the journal plugin will be taken from the [[com.typesafe.config.Config]] loaded into the
* [[ActorSystem]].
* When configured, the journal plugin configuration will be taken from this [[Config]] merged with the [[Config]]
* When configured, the journal plugin configuration will be taken from this [[com.typesafe.config.Config]] merged with the [[com.typesafe.config.Config]]
* loaded into the [[ActorSystem]].
*
* @return an additional configuration used to configure the journal plugin.
@ -139,9 +139,9 @@ trait RuntimePluginConfig {
/**
* Additional configuration of the snapshot plugin servicing this persistent actor.
* When empty, the whole configuration of the snapshot plugin will be taken from the [[Config]] loaded into the
* When empty, the whole configuration of the snapshot plugin will be taken from the [[com.typesafe.config.Config]] loaded into the
* [[ActorSystem]].
* When configured, the snapshot plugin configuration will be taken from this [[Config]] merged with the [[Config]]
* When configured, the snapshot plugin configuration will be taken from this [[com.typesafe.config.Config]] merged with the [[com.typesafe.config.Config]]
* loaded into the [[ActorSystem]].
*
* @return an additional configuration used to configure the snapshot plugin.

17
project/Doc.scala
View file

@ -155,7 +155,11 @@ object UnidocRoot extends AutoPlugin {
ScalaUnidoc / unidocProjectFilter := unidocRootProjectFilter(unidocRootIgnoreProjects.value),
JavaUnidoc / unidocProjectFilter := unidocRootProjectFilter(unidocRootIgnoreProjects.value),
Compile / doc / apiMappings ++= {
val entries: Seq[Attributed[File]] = (LocalProject("slf4j") / Compile / fullClasspath).value
val entries: Seq[Attributed[File]] =
(LocalProject("slf4j") / Compile / fullClasspath).value ++
(LocalProject("persistence") / Compile / fullClasspath).value ++
(LocalProject("remote") / Compile / fullClasspath).value ++
(LocalProject("stream") / Compile / fullClasspath).value
def mappingsFor(organization: String, names: List[String], location: String,
revision: String => String = identity): Seq[(File, URL)] = {
@ -167,8 +171,14 @@ object UnidocRoot extends AutoPlugin {
} yield entry.data -> url(location.format(module.revision))
}
val mappings: Seq[(File, URL)] =
mappingsFor("org.slf4j", List("slf4j-api"), "https://www.javadoc.io/doc/org.slf4j/slf4j-api/%s/")
val mappings: Seq[(File, URL)] = {
mappingsFor("org.slf4j", List("slf4j-api"), "https://www.javadoc.io/doc/org.slf4j/slf4j-api/%s/") ++
mappingsFor("com.typesafe", List("config"), "https://www.javadoc.io/doc/com.typesafe/config/%s/") ++
mappingsFor("io.aeron", List("aeron-client", "aeron-driver"),
"https://www.javadoc.io/doc/io.aeron/aeron-all/%s/") ++
mappingsFor("org.reactivestreams", List("reactive-streams"),
"https://www.javadoc.io/doc/org.reactivestreams/reactive-streams/%s/")
}
mappings.toMap
},
@ -200,6 +210,7 @@ object UnidocRoot extends AutoPlugin {
object BootstrapGenjavadoc extends AutoPlugin {
override def trigger = allRequirements
override def requires =
UnidocRoot.CliOptions.genjavadocEnabled
.ifTrue {

2
remote/src/main/java/org/apache/pekko/remote/artery/aeron/AeronErrorLog.java
View file

@ -35,7 +35,7 @@ import java.util.concurrent.atomic.AtomicLong;
*
* <p>Application to print out errors recorded in the command-and-control (cnc) file is maintained
* by media driver in shared memory. This application reads the cnc file and prints the distinct
* errors. Layout of the cnc file is described in {@link CncFileDescriptor}.
* errors. Layout of the cnc file is described in {@link io.aeron.CncFileDescriptor}.
*/
public class AeronErrorLog {
final MappedByteBuffer cncByteBuffer;