Skip to content

Commit

Permalink
[core] Update the documentation of the events.
Browse files Browse the repository at this point in the history
Signed-off-by: Stéphane Galland <galland@arakhne.org>
  • Loading branch information
gallandarakhneorg committed Oct 20, 2017
1 parent 20f94b7 commit 1ebe70b
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions main/apiplugins/io.sarl.core/src/io/sarl/core/events.sarl
Expand Up @@ -263,6 +263,7 @@ final event SpaceDestroyed {
/** Notifies other members the member with agentID has effectively
* integrated the holon context.
* The event is fired within the default space of the context in which the new agent entered.
* The joining agent does not receive this event.
* The source of the event is the parent agent.
* The context id can be retrieved via {@code ev.source.spaceID.contextID}.
*/
Expand Down Expand Up @@ -301,6 +302,7 @@ final event MemberJoined {
/** Notifies other members the member with agentID was
* excluded (forced to leave) the holon context parentContextID.
* The event is fired within the default space of the context from which the agent was excluded.
* The excluded agent does not receive this event.
* The source of the event is the parent agent.
* The context id can be retrieved via {@code ev.source.spaceID.contextID}.
*/
Expand Down Expand Up @@ -338,6 +340,7 @@ final event MemberExcluded {

/** Notifies other members the member with agentID has left the holon context.
* The event is fired within the default space of the context from which the agent has left.
* The left agent does not receive this event.
* The source of the event is the parent agent.
* The context id can be retrieved via {@code ev.source.spaceID.contextID}.
*/
Expand Down

0 comments on commit 1ebe70b

Please sign in to comment.