From 2883a04f0841d11237f8010341cca6832cfa0aef Mon Sep 17 00:00:00 2001
From: guille <guillermopolito@gmail.com>
Date: Thu, 27 Oct 2016 16:06:26 +0200
Subject: [PATCH] Added Scaladocs to InputLayerActor
---
.../n2s3/core/actors/InputLayerActor.scala | 23 +++++++++++--------
1 file changed, 13 insertions(+), 10 deletions(-)
diff --git a/n2s3/src/main/scala/fr/univ_lille/cristal/emeraude/n2s3/core/actors/InputLayerActor.scala b/n2s3/src/main/scala/fr/univ_lille/cristal/emeraude/n2s3/core/actors/InputLayerActor.scala
index 09cec0c7..bea6121f 100644
--- a/n2s3/src/main/scala/fr/univ_lille/cristal/emeraude/n2s3/core/actors/InputLayerActor.scala
+++ b/n2s3/src/main/scala/fr/univ_lille/cristal/emeraude/n2s3/core/actors/InputLayerActor.scala
@@ -7,17 +7,20 @@ import fr.univ_lille.cristal.emeraude.n2s3.support.actors.{ActorCompanion, Props
import fr.univ_lille.cristal.emeraude.n2s3.support.io.{InputSeq, N2S3Input}
/**
- * Created by guille on 10/14/16.
+ * Actor companion of [[InputLayerActor]].
+ * It defines now to create such actor by defining a props builder
*/
-class InputLayerActor(stream: StreamSupport[_, InputSeq[N2S3Input]]) extends NetworkEntityActor(new InputLayer(stream))
-
-/** ******************************************************************************************************************
- * Actor companion
- * *****************************************************************************************************************/
-
object InputLayerActor extends ActorCompanion {
- override def newPropsBuilder(): PropsBuilder = new SinglePropsBuilder[InputLayerActor]
- case class Stimulus(neuronIndex: Int, timestamp: Timestamp)
+ /**
+ * Returns a props builder to build an [[InputLayerActor]]
+ */
+ override def newPropsBuilder(): PropsBuilder = new SinglePropsBuilder[InputLayerActor]
+}
-}
\ No newline at end of file
+/**
+ * Actor for input layers.
+ * This actor is built as a NetworkEntityActor using a single [[InputLayer]] as network entity.
+ * @param stream the stream that will be used by the input layer to read data from
+ */
+class InputLayerActor(stream: StreamSupport[_, InputSeq[N2S3Input]]) extends NetworkEntityActor(new InputLayer(stream))
--
GitLab