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

Link to replicator case object (#28439)

Browse source 
* 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
This commit is contained in:
Arnout Engelen 2020-01-08 13:47:43 +01:00 • committed by Patrik Nordwall
parent c7e79031d8
commit fb7c695d15
2 changed files with 5 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

1
akka-cluster-typed/src/main/scala/akka/cluster/ddata/typed/javadsl/Replicator.scala
View file

@ -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

9
akka-docs/src/main/paradox/typed/distributed-data.md
View file

@ -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: