Add scaladoc for SerialRef

evolution-gaming · Jan 15, 2024 · 1e0b05b · 1e0b05b
1 parent 7ee706e
commit 1e0b05b
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 0 deletions.
diff --git a/build.sbt b/build.sbt
@@ -25,6 +25,8 @@ inThisBuild(Seq(
   scalaVersion := crossScalaVersions.value.head,
 
   publishTo := Some(Resolver.evolutionReleases),
+
+  autoAPIMappings := true,
 ))
 
 // Settings that can't be defined on a higher level go here.

diff --git a/core/src/main/scala/com/evolutiongaming/catshelper/SerialRef.scala b/core/src/main/scala/com/evolutiongaming/catshelper/SerialRef.scala
@@ -6,6 +6,12 @@ import cats.effect.std.Semaphore
 import cats.implicits._
 import cats.~>
 
+/** Similar to [[cats.effect.std.AtomicCell]].
+  * 
+  * [[SerialRef]] was created when [[cats.effect.std.AtomicCell]] did not exist
+  * yet, and is kept for backwards compatibility purposes and ability to use
+  * the same code for both Cats Effect 2 and Cats Effect 3.
+  */
 trait SerialRef[F[_], A] {
 
   def get: F[A]