From fb7c695d1558f94f4c34d25ffe6f2d3a923eb0f8 Mon Sep 17 00:00:00 2001 From: Arnout Engelen Date: Wed, 8 Jan 2020 13:47:43 +0100 Subject: [PATCH] Link to replicator case object (#28439) * Link to replicator case object (#28427) Unfortunately apidoc cannot detect when you link to a class but only the corresponding object exists in the scaladoc, not the class itself. * Further clarifications --- .../akka/cluster/ddata/typed/javadsl/Replicator.scala | 1 + akka-docs/src/main/paradox/typed/distributed-data.md | 9 ++++----- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/akka-cluster-typed/src/main/scala/akka/cluster/ddata/typed/javadsl/Replicator.scala b/akka-cluster-typed/src/main/scala/akka/cluster/ddata/typed/javadsl/Replicator.scala index b2c7d5f55d..ef5092160a 100644 --- a/akka-cluster-typed/src/main/scala/akka/cluster/ddata/typed/javadsl/Replicator.scala +++ b/akka-cluster-typed/src/main/scala/akka/cluster/ddata/typed/javadsl/Replicator.scala @@ -332,6 +332,7 @@ object Replicator { /** * INTERNAL API + * Obtain the instance of this class with the [[#flushChanges]] method. */ @InternalApi private[akka] case object FlushChanges extends Command diff --git a/akka-docs/src/main/paradox/typed/distributed-data.md b/akka-docs/src/main/paradox/typed/distributed-data.md index fb56b323cf..bb821f7b84 100644 --- a/akka-docs/src/main/paradox/typed/distributed-data.md +++ b/akka-docs/src/main/paradox/typed/distributed-data.md @@ -40,12 +40,11 @@ out-of-date value. ## Using the Replicator -The @apidoc[typed.*.Replicator] -actor provides the API for interacting with the data and is accessed through the extension -@apidoc[typed.*.DistributedData]. +You can interact with the data through the replicator actor which can be +accessed through the @apidoc[typed.*.DistributedData] extension. -The messages for the replicator, such as `Replicator.Update` are defined in -@scala[`akka.cluster.ddata.typed.scaladsl.Replicator`]@java[`akka.cluster.ddata.typed.javaadsl.Replicator`] +The messages for the replicator, such as @apidoc[typed.*Replicator.Update] are defined as +subclasses of @apidoc[typed.*Replicator.Command] and the actual CRDTs are defined in the `akka.cluster.ddata` package, for example @apidoc[akka.cluster.ddata.GCounter]. It requires a @scala[implicit] `akka.cluster.ddata.SelfUniqueAddress`, available from: