From adba3a944a7d4e09b50950ecd321f34539660111 Mon Sep 17 00:00:00 2001
From: guille <guillermopolito@gmail.com>
Date: Thu, 27 Oct 2016 16:06:59 +0200
Subject: [PATCH] added scaladocs to Config

---
 .../cristal/emeraude/n2s3/core/actors/Config.scala         | 7 ++++---
 1 file changed, 4 insertions(+), 3 deletions(-)

diff --git a/n2s3/src/main/scala/fr/univ_lille/cristal/emeraude/n2s3/core/actors/Config.scala b/n2s3/src/main/scala/fr/univ_lille/cristal/emeraude/n2s3/core/actors/Config.scala
index 318ea7e8..b464caab 100644
--- a/n2s3/src/main/scala/fr/univ_lille/cristal/emeraude/n2s3/core/actors/Config.scala
+++ b/n2s3/src/main/scala/fr/univ_lille/cristal/emeraude/n2s3/core/actors/Config.scala
@@ -9,17 +9,18 @@ import akka.util.Timeout
 import scala.concurrent.duration._
 
 /**
-  * Object which contains default parameters for N2S3
+  * This object contains default parameters for a N2S3 simulation.
+  * This object is immutable.
   */
 object Config {
 
   /**
-    * default timeout used in wait patterns
+    * Default timeout to use in wait patterns
     */
   val defaultTimeout = Timeout(60 seconds)
 
   /**
-    * default timeout used in wait patterns, when a long process is in progress
+    * Default timeout to use in wait patterns when a long process is in progress
     */
   val longTimeout = Timeout(21474835 seconds)
 }
-- 
GitLab