Adds a more meaningful documentation to 'seed' (cf. #3300)

gama-platform · Feb 11, 2022 · 0e57d04 · 0e57d04
1 parent d23ad76
commit 0e57d04
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 4 deletions.
diff --git a/msi.gama.core/src/msi/gama/kernel/experiment/ExperimentAgent.java b/msi.gama.core/src/msi/gama/kernel/experiment/ExperimentAgent.java
@@ -101,8 +101,7 @@
 				name = IKeyword.SEED,
 				type = IType.FLOAT,
 				doc = @doc (
-						value = "The seed of the random number generator",
-						comment = "Each time it is set, the random number generator is reinitialized")),
+						value = "The seed of the random number generator. Each time it is set, the random number generator is reinitialized. WARNING: Setting it to zero actually means that you let GAMA choose a random seed")),
 		@variable (
 				name = IKeyword.RNG,
 				type = IType.STRING,

diff --git a/msi.gama.core/src/msi/gama/kernel/simulation/SimulationAgent.java b/msi.gama.core/src/msi/gama/kernel/simulation/SimulationAgent.java
@@ -76,6 +76,10 @@
  * @todo Description
  *
  */
+
+/**
+ * The Class SimulationAgent.
+ */
 @species (
 		name = IKeyword.MODEL,
 		internal = true)
@@ -89,8 +93,7 @@
 				name = IKeyword.SEED,
 				type = IType.FLOAT,
 				doc = @doc (
-						value = "The seed of the random number generator",
-						comment = "Each time it is set, the random number generator is reinitialized")),
+						value = "The seed of the random number generator. Each time it is set, the random number generator is reinitialized. WARNING: Setting it to zero actually means that you let GAMA choose a random seed.")),
 		@variable (
 				name = IKeyword.RNG,
 				type = IType.STRING,