From 574c8e49ebe0b2d583c0f37d3fe222706e6782ff Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?St=C3=A9phane=20Galland?= <galland@arakhne.org>
Date: Thu, 25 Jan 2018 18:04:06 +0100
Subject: [PATCH] [core] Update documentation about the parallel execution
 behavior of the spawning functions.
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Signed-off-by: Stéphane Galland <galland@arakhne.org>
---
 .../io.sarl.core/src/io/sarl/core/bic.sarl    | 20 +++++++++++++++++++
 1 file changed, 20 insertions(+)

diff --git a/main/apiplugins/io.sarl.core/src/io/sarl/core/bic.sarl b/main/apiplugins/io.sarl.core/src/io/sarl/core/bic.sarl
index d6ff4659f4..c1ef4c32c9 100644
--- a/main/apiplugins/io.sarl.core/src/io/sarl/core/bic.sarl
+++ b/main/apiplugins/io.sarl.core/src/io/sarl/core/bic.sarl
@@ -363,6 +363,10 @@ capacity Lifecycle {
 	 * This action must automatically register the newly created agent
 	 * within the default space of the context.
 	 *
+	 * <p>Caution: when this function returns, it replies the UUID of the spawned agent.
+	 * But, there is no warranty that the agent with this id is initialized at the time of the return.
+	 * Indeed, agent spawning is done in parallel to the calling thread.
+	 *
 	 * <p>This function does nothing if one of the following conditions evaluates to true:
 	 * <ul>
 	 * <li>the agent is not alive.</li>
@@ -381,6 +385,10 @@ capacity Lifecycle {
 	 * This action must automatically register the newly created agents
 	 * within the default space of the context.
 	 *
+	 * <p>Caution: when this function returns, it replies the UUIDs of the spawned agents.
+	 * But, there is no warranty that the agents with th ids are initialized at the time of the return.
+	 * Indeed, agent spawning is done in parallel to the calling thread.
+	 *
 	 * <p>This function does nothing if one of the following conditions evaluates to true:
 	 * <ul>
 	 * <li>the agent is not alive.</li>
@@ -399,6 +407,10 @@ capacity Lifecycle {
 	/**
 	 * Spawns a new member agent in the parent's context (parentID).
 	 *
+	 * <p>Caution: when this function returns, it replies the UUID of the spawned agent.
+	 * But, there is no warranty that the agent with this id is initialized at the time of the return.
+	 * Indeed, agent spawning is done in parallel to the calling thread.
+	 *
 	 * <p>This function does nothing if one of the following conditions evaluates to true:
 	 * <ul>
 	 * <li>the agent is not alive.</li>
@@ -415,6 +427,10 @@ capacity Lifecycle {
 	/**
 	 * Spawns a group of agents in the parent's context (parentID).
 	 *
+	 * <p>Caution: when this function returns, it replies the UUIDs of the spawned agents.
+	 * But, there is no warranty that the agents with th ids are initialized at the time of the return.
+	 * Indeed, agent spawning is done in parallel to the calling thread.
+	 *
 	 * <p>This function does nothing if one of the following conditions evaluates to true:
 	 * <ul>
 	 * <li>the agent is not alive.</li>
@@ -434,6 +450,10 @@ capacity Lifecycle {
 	/**
 	 * Spawns a new member agent in the parent's context (parentID).
 	 *
+	 * <p>Caution: when this function returns, it replies the UUID of the spawned agent.
+	 * But, there is no warranty that the agent with this id is initialized at the time of the return.
+	 * Indeed, agent spawning is done in parallel to the calling thread.
+	 *
 	 * <p>This function does nothing if one of the following conditions evaluates to true:
 	 * <ul>
 	 * <li>the agent is not alive.</li>