scaladoc added

Author: rssh

build.sbt

@@ -19,17 +19,20 @@ lazy val root = project
   .in(file("."))
   .aggregate(gopher.js, gopher.jvm)
   .settings(
-    Sphinx / sourceDirectory := baseDirectory.value / "docs",
     git.remoteRepo := "[email protected]:rssh/scala-gopher.git",
+    SiteScaladocPlugin.scaladocSettings(GopherJVM, gopher.jvm / Compile / packageDoc / mappings, "api/jvm"),
+    SiteScaladocPlugin.scaladocSettings(GopherJS,  gopher.js / Compile / packageDoc / mappings, "api/js"),
+    siteDirectory :=  baseDirectory.value / "target" / "site",
     publishArtifact := false,
-  ).enablePlugins(GhpagesPlugin)
+  ).enablePlugins(GhpagesPlugin, SiteScaladocPlugin)
 
 
 
 lazy val gopher = crossProject(JSPlatform, JVMPlatform)
     .in(file("."))
     .settings(sharedSettings)
     .disablePlugins(SitePlugin)
+    .disablePlugins(SitePreviewPlugin)
     .jvmSettings(
         scalacOptions ++= Seq( "-unchecked", "-Ycheck:macros", "-uniqid", "-Xprint:types" ),
     ).jsSettings(
@@ -39,3 +42,5 @@ lazy val gopher = crossProject(JSPlatform, JVMPlatform)
         scalaJSUseMainModuleInitializer := true,
     )
 
+lazy val GopherJVM = config("gopher.jvm")
+lazy val GopherJS = config("gopher.js")

project/plugins.sbt

@@ -1,5 +1,5 @@
 addSbtPlugin("com.jsuereth" % "sbt-pgp" % "2.0.2")
-addSbtPlugin("com.typesafe.sbt" % "sbt-site" % "1.4.0")
+addSbtPlugin("com.typesafe.sbt" % "sbt-site" % "1.4.1")
 addSbtPlugin("com.typesafe.sbt" % "sbt-ghpages" % "0.6.3")
 addSbtPlugin("org.portable-scala" % "sbt-scalajs-crossproject"      % "1.0.0")
 addSbtPlugin("org.scala-js" % "sbt-scalajs"      % "1.5.1")

shared/src/main/scala/gopher/ReadChannel.scala

@@ -10,7 +10,10 @@ import scala.concurrent.duration.Duration
 
 import java.util.logging.{Level => LogLevel}
 
-
+/**
+ * ReadChannel:  Interface providing reading API.  
+ * 
+ **/
 trait ReadChannel[F[_], A]:
 
    thisReadChannel =>

shared/src/main/scala/gopher/Select.scala

@@ -6,9 +6,26 @@ import scala.quoted._
 import scala.compiletime._
 import scala.concurrent.duration._
 
-
+/** Organize waiting for read/write from multiple async channels
+ *  
+ *  Gopher[F] provide a function `select` of this type.
+ */
 class Select[F[_]](api: Gopher[F]):
 
+  /** wait until some channels from the list in <code> pf </code>.
+   *
+   *```Scala
+   *async{
+   *  ....  
+   *  select {
+   *    case vx:xChannel.read => doSomethingWithX 
+   *    case vy:yChannel.write if (vy == valueToWrite) => doSomethingAfterWrite(vy)
+   *    case t: Time.after if (t == 1.minute) => processTimeout
+   *  }
+   *  ...
+   *}
+   *```
+   */
   transparent inline def apply[A](inline pf: PartialFunction[Any,A]): A =
     ${  
       Select.onceImpl[F,A]('pf, 'api )  
@@ -51,9 +68,7 @@ class Select[F[_]](api: Gopher[F]):
   def afold_async[S](s0:S)(step: S => F[S | SelectFold.Done[S]]) : F[S] =
     fold_async(s0)(step)
 
-    
-  //def map[A](step: PartialFunction[SelectGroup[F,A],A|SelectFold.Done[Unit]]): ReadChannel[F,A] =
-  
+      
   def map[A](step: SelectGroup[F,A] => A): ReadChannel[F,A] =
     mapAsync[A](x => api.asyncMonad.pure(step(x)))