docs: improve scaladoc

ScaRLib-group · Dec 11, 2023 · 0870554 · 0870554
1 parent f98d0bf
commit 0870554
Show file tree

Hide file tree

Showing 4 changed files with 8 additions and 0 deletions.
diff --git a/alchemist-scafi/src/main/scala/it/unibo/alchemist/CollectiveAction.scala b/alchemist-scafi/src/main/scala/it/unibo/alchemist/CollectiveAction.scala
@@ -17,6 +17,7 @@ import org.danilopianini.util.{ListSet, ListSets}
 import java.util
 import _root_.scala.jdk.CollectionConverters.IteratorHasAsScala
 
+/** Represents a collective action performed after that each agent has decided the individual [[Action]] */
 abstract class CollectiveAction[T, P <: Position[P]](
     val environment: Environment[T,P],
     distribution: TimeDistribution[T]

diff --git a/dsl-core/src/main/scala/it/unibo/scarlib/dsl/DSL.scala b/dsl-core/src/main/scala/it/unibo/scarlib/dsl/DSL.scala
@@ -16,6 +16,7 @@ import scala.reflect.runtime.{universe => ru}
 
 import scala.concurrent.ExecutionContext
 
+/** The module that contains the internal domain specific language used to configure a learning system */
 object DSL {
 
   private var rf: Option[RewardFunction] = None

diff --git a/scarlib-core/src/main/scala/it/unibo/scarlib/core/model/Agent.scala b/scarlib-core/src/main/scala/it/unibo/scarlib/core/model/Agent.scala
@@ -13,5 +13,8 @@ import scala.concurrent.Future
 
 /** A generic agent */
 trait Agent {
+  /** A single interaction of the agent with the environment
+   * @return a [[Future]] that indicates when the interaction is completed
+   * */
   def step(): Future[Unit]
 }
diff --git a/scarlib-core/src/main/scala/it/unibo/scarlib/core/neuralnetwork/NeuralNetworkEncoding.scala b/scarlib-core/src/main/scala/it/unibo/scarlib/core/neuralnetwork/NeuralNetworkEncoding.scala
@@ -11,8 +11,11 @@ package it.unibo.scarlib.core.neuralnetwork
 
 import it.unibo.scarlib.core.model.State
 
+/** A type-class that represents how a [[State]] is encoded and passed to the neural network*/
 trait NeuralNetworkEncoding[A <: State]{
+    /** The number of element in the encoding */
     def elements(): Int
 
+    /** The encoded state */
     def toSeq(element: A): Seq[Double]
 }