Add scaladoc for ClusterShardingLocal and DataCenter

evolution-gaming · Oct 13, 2023 · 2e58bae · 2e58bae
1 parent 18fe5d9
commit 2e58bae
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 3 deletions.
diff --git a/...src/main/scala/com/evolutiongaming/akkaeffect/cluster/sharding/ClusterShardingLocal.scala b/...src/main/scala/com/evolutiongaming/akkaeffect/cluster/sharding/ClusterShardingLocal.scala
@@ -19,11 +19,17 @@ import scala.concurrent.Promise
 import scala.concurrent.duration._
 import scala.util.Try
 
-
+/** Stub for [[ClusterSharding]] to be used in the unit tests. */
 trait ClusterShardingLocal[F[_]] {
 
+  /** Provides the actual stub */
   def clusterSharding: ClusterSharding[F]
 
+  /** Simulate cluster rebalacing.
+    *
+    * I.e. send `handOffStopMessage` from [[ClusterSharding#startProxy]] to the
+    * actors that need rebalancing according to `shardAllocationStrategy`.
+    */
   def rebalance: F[Unit]
 }
 

diff --git a/cluster/src/main/scala/com/evolutiongaming/akkaeffect/cluster/DataCenter.scala b/cluster/src/main/scala/com/evolutiongaming/akkaeffect/cluster/DataCenter.scala
@@ -3,7 +3,7 @@ package com.evolutiongaming.akkaeffect.cluster
 import cats.{Order, Show}
 import pureconfig.ConfigReader
 
-
+/** Datacenter where required cluster singletons are located */
 final case class DataCenter(value: String) {
 
   override def toString: String = value
@@ -16,4 +16,4 @@ object DataCenter {
   implicit val showDataCenter: Show[DataCenter] = Show.fromToString
 
   implicit val configReaderDataCenter: ConfigReader[DataCenter] = ConfigReader[String].map { a => DataCenter(a) }
-}
+}