Skip to content

Commit

Permalink
[lang] Update the documentation of AgentContext.
Browse files Browse the repository at this point in the history
see #242
see janus-project/janusproject#92

Signed-off-by: Stéphane Galland <galland@arakhne.org>
  • Loading branch information
gallandarakhneorg committed Nov 25, 2014
1 parent 55eee6c commit 8344deb
Showing 1 changed file with 5 additions and 3 deletions.
Expand Up @@ -56,14 +56,16 @@ public interface AgentContext {

/** Create an instance of space following the given specification.
* This function always creates a new instance of space.
* It means that is a space with the given identifier already
* exists, this function does nothing and replies <code>null</code>.
* If you want to find an existing space prior to the creation of
* a new one, you should use {@link #getOrCreateSpace(Class, UUID, Object...)}.
*
* @param <S> - type of the created space.
* @param spec - specification of the space to create.
* @param spaceUUID - identifier of the new space.
* @param creationParams - parameters to pass to the space constructor.
* @return the new space.
* @return the new space, or <code>null</code> if the space already exists.
* @see #getOrCreateSpace(Class, UUID, Object...)
* @see #getSpace(UUID)
*/
Expand All @@ -80,14 +82,14 @@ <S extends Space> S createSpace(Class<? extends SpaceSpecification<S>> spec,

/** Retreive or create an instance of space following the given specification.
* This function tries to find a space that fits the given specification.
* If none wis found, this function create a new space in the same way as
* If none was found, this function create a new space in the same way as
* {@link #createSpace(Class, UUID, Object...)}.
*
* @param <S> - type of the replied space.
* @param spec - specification of the space to create.
* @param spaceUUID - identifier of the new space.
* @param creationParams - parameters to pass to the space constructor.
* @return the new space.
* @return the new space, never <code>null</code>.
* @see #createSpace(Class, UUID, Object...)
* @see #getSpace(UUID)
*/
Expand Down

0 comments on commit 8344deb

Please sign in to comment.