From 23cc5980b3109c991fac56e99e96936dff4103ec Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Thibaut=20D=C3=A9mare?= <fdhp_76@hotmail.com>
Date: Wed, 12 Feb 2014 09:29:53 +0100
Subject: [PATCH] Some javadoc

---
 .../extension/sender/AddEdgeAttributeStatement.java   | 10 +++++++++-
 .../gama/extension/sender/AddEdgeStatement.java       |  9 +++++++++
 .../extension/sender/AddGraphAttributeStatement.java  | 10 +++++++++-
 .../extension/sender/AddNodeAttributeStatement.java   | 10 +++++++++-
 .../gama/extension/sender/AddNodeStatement.java       |  9 +++++++++
 .../gama/extension/sender/AddSenderStatement.java     |  9 +++++++++
 .../gama/extension/sender/ClearSendersStatement.java  |  9 +++++++++
 .../gama/extension/sender/ClearStatement.java         | 11 +++++++++--
 .../gama/extension/sender/CloseStatement.java         | 10 +++++++++-
 .../sender/RemoveEdgeAttributeStatement.java          | 10 +++++++++-
 .../gama/extension/sender/RemoveEdgeStatement.java    |  9 +++++++++
 .../sender/RemoveGraphAttributeStatement.java         | 10 +++++++++-
 .../sender/RemoveNodeAttributeStatement.java          | 10 +++++++++-
 .../gama/extension/sender/RemoveNodeStatement.java    |  9 +++++++++
 .../gama/extension/sender/StepStatement.java          | 10 +++++++++-
 15 files changed, 135 insertions(+), 10 deletions(-)

diff --git a/src/org/graphstream/gama/extension/sender/AddEdgeAttributeStatement.java b/src/org/graphstream/gama/extension/sender/AddEdgeAttributeStatement.java
index 4ab8a29..69c4d83 100644
--- a/src/org/graphstream/gama/extension/sender/AddEdgeAttributeStatement.java
+++ b/src/org/graphstream/gama/extension/sender/AddEdgeAttributeStatement.java
@@ -16,7 +16,15 @@ import msi.gaml.types.IType;
 import org.graphstream.gama.extension.GSManager;
 import org.graphstream.gama.extension.IKeywordGSAdditional;
 
-
+/**
+ * Implements the {@code gs_add_edge_attribute} command.
+ *
+ * <pre>
+ * gs_add_edge_attribute gs_sender_id:senderId gs_edge_id:edgeId gs_attribute_name:name gs_attribute_value:value;
+ * </pre>
+ * @author Thibaut Démare
+ *
+ */
 @symbol(name = IKeywordGSAdditional.ADD_EDGE_ATTRIBUTE, kind = ISymbolKind.SINGLE_STATEMENT, with_sequence = false)
 @inside(kinds = { ISymbolKind.BEHAVIOR, ISymbolKind.SEQUENCE_STATEMENT, ISymbolKind.LAYER })
 @facets(value = { @facet(name = IKeywordGSAdditional.SENDERID, type = IType.STRING, optional = false),
diff --git a/src/org/graphstream/gama/extension/sender/AddEdgeStatement.java b/src/org/graphstream/gama/extension/sender/AddEdgeStatement.java
index ec5c099..36617b9 100644
--- a/src/org/graphstream/gama/extension/sender/AddEdgeStatement.java
+++ b/src/org/graphstream/gama/extension/sender/AddEdgeStatement.java
@@ -16,6 +16,15 @@ import msi.gaml.types.IType;
 import org.graphstream.gama.extension.GSManager;
 import org.graphstream.gama.extension.IKeywordGSAdditional;
 
+/**
+ * Implements the {@code gs_add_edge} command.
+ *
+ * <pre>
+ * gs_add_edge gs_sender_id:senderId gs_edge_id:edgeId gs_node_id_from:nodeId gs_node_id_to:nodeId gs_is_directed:dir;
+ * </pre>
+ * @author Thibaut Démare
+ *
+ */
 @symbol(name = IKeywordGSAdditional.ADD_EDGE, kind = ISymbolKind.SINGLE_STATEMENT, with_sequence = false)
 @inside(kinds = { ISymbolKind.BEHAVIOR, ISymbolKind.SEQUENCE_STATEMENT, ISymbolKind.LAYER })
 @facets(value = { @facet(name = IKeywordGSAdditional.SENDERID, type = IType.STRING, optional = false),
diff --git a/src/org/graphstream/gama/extension/sender/AddGraphAttributeStatement.java b/src/org/graphstream/gama/extension/sender/AddGraphAttributeStatement.java
index a7776e2..f960706 100644
--- a/src/org/graphstream/gama/extension/sender/AddGraphAttributeStatement.java
+++ b/src/org/graphstream/gama/extension/sender/AddGraphAttributeStatement.java
@@ -16,7 +16,15 @@ import msi.gaml.types.IType;
 import org.graphstream.gama.extension.GSManager;
 import org.graphstream.gama.extension.IKeywordGSAdditional;
 
-
+/**
+ * Implements the {@code gs_add_graph_attribute} command.
+ *
+ * <pre>
+ * gs_add_graph_attribute gs_sender_id:senderId gs_attribute_name:name gs_attribute_value:value;
+ * </pre>
+ * @author Thibaut Démare
+ *
+ */
 @symbol(name = IKeywordGSAdditional.ADD_GRAPH_ATTRIBUTE, kind = ISymbolKind.SINGLE_STATEMENT, with_sequence = false)
 @inside(kinds = { ISymbolKind.BEHAVIOR, ISymbolKind.SEQUENCE_STATEMENT, ISymbolKind.LAYER })
 @facets(value = { @facet(name = IKeywordGSAdditional.SENDERID, type = IType.STRING, optional = false),
diff --git a/src/org/graphstream/gama/extension/sender/AddNodeAttributeStatement.java b/src/org/graphstream/gama/extension/sender/AddNodeAttributeStatement.java
index 34dbeba..f53ec13 100644
--- a/src/org/graphstream/gama/extension/sender/AddNodeAttributeStatement.java
+++ b/src/org/graphstream/gama/extension/sender/AddNodeAttributeStatement.java
@@ -16,7 +16,15 @@ import msi.gaml.types.IType;
 import org.graphstream.gama.extension.GSManager;
 import org.graphstream.gama.extension.IKeywordGSAdditional;
 
-
+/**
+ * Implements the {@code gs_add_node_attribute} command.
+ *
+ * <pre>
+ * gs_add_node_attribute gs_sender_id:senderId gs_node_id:nodeId gs_attribute_name:name gs_attribute_value:value;
+ * </pre>
+ * @author Thibaut Démare
+ *
+ */
 @symbol(name = IKeywordGSAdditional.ADD_NODE_ATTRIBUTE, kind = ISymbolKind.SINGLE_STATEMENT, with_sequence = false)
 @inside(kinds = { ISymbolKind.BEHAVIOR, ISymbolKind.SEQUENCE_STATEMENT, ISymbolKind.LAYER })
 @facets(value = { @facet(name = IKeywordGSAdditional.SENDERID, type = IType.STRING, optional = false),
diff --git a/src/org/graphstream/gama/extension/sender/AddNodeStatement.java b/src/org/graphstream/gama/extension/sender/AddNodeStatement.java
index 3e95a15..f5e9fa9 100644
--- a/src/org/graphstream/gama/extension/sender/AddNodeStatement.java
+++ b/src/org/graphstream/gama/extension/sender/AddNodeStatement.java
@@ -16,6 +16,15 @@ import msi.gaml.types.IType;
 import org.graphstream.gama.extension.GSManager;
 import org.graphstream.gama.extension.IKeywordGSAdditional;
 
+/**
+ * Implements the {@code gs_add_node} command.
+ *
+ * <pre>
+ * gs_add_node gs_sender_id:senderId gs_node_id:nodeId;
+ * </pre>
+ * @author Thibaut Démare
+ *
+ */
 @symbol(name = IKeywordGSAdditional.ADD_NODE, kind = ISymbolKind.SINGLE_STATEMENT, with_sequence = false)
 @inside(kinds = { ISymbolKind.BEHAVIOR, ISymbolKind.SEQUENCE_STATEMENT, ISymbolKind.LAYER })
 @facets(value = { @facet(name = IKeywordGSAdditional.SENDERID, type = IType.STRING, optional = false),
diff --git a/src/org/graphstream/gama/extension/sender/AddSenderStatement.java b/src/org/graphstream/gama/extension/sender/AddSenderStatement.java
index 0e80b5f..59d9532 100644
--- a/src/org/graphstream/gama/extension/sender/AddSenderStatement.java
+++ b/src/org/graphstream/gama/extension/sender/AddSenderStatement.java
@@ -16,6 +16,15 @@ import msi.gaml.types.IType;
 import org.graphstream.gama.extension.GSManager;
 import org.graphstream.gama.extension.IKeywordGSAdditional;
 
+/**
+ * Implements the {@code gs_add_sender} command.
+ *
+ * <pre>
+ * gs_add_sender gs_sender_id:senderId gs_nhost:host gs_port:port;
+ * </pre>
+ * @author Thibaut Démare
+ *
+ */
 @symbol(name = IKeywordGSAdditional.ADD_SENDER, kind = ISymbolKind.SINGLE_STATEMENT, with_sequence = false)
 @inside(kinds = { ISymbolKind.BEHAVIOR, ISymbolKind.SEQUENCE_STATEMENT, ISymbolKind.LAYER })
 @facets(value = { @facet(name = IKeywordGSAdditional.SENDERID, type = IType.STRING, optional = false),
diff --git a/src/org/graphstream/gama/extension/sender/ClearSendersStatement.java b/src/org/graphstream/gama/extension/sender/ClearSendersStatement.java
index 639e258..d1f9e9c 100644
--- a/src/org/graphstream/gama/extension/sender/ClearSendersStatement.java
+++ b/src/org/graphstream/gama/extension/sender/ClearSendersStatement.java
@@ -12,6 +12,15 @@ import msi.gaml.statements.IStatement;
 import org.graphstream.gama.extension.GSManager;
 import org.graphstream.gama.extension.IKeywordGSAdditional;
 
+/**
+ * Implements the {@code gs_clear_senders} command.
+ *
+ * <pre>
+ * gs_clear_senders;
+ * </pre>
+ * @author Thibaut Démare
+ *
+ */
 @symbol(name = IKeywordGSAdditional.CLEAR_SENDERS, kind = ISymbolKind.SINGLE_STATEMENT, with_sequence = false)
 @inside(kinds = { ISymbolKind.BEHAVIOR, ISymbolKind.SEQUENCE_STATEMENT, ISymbolKind.LAYER })
 public class ClearSendersStatement extends AbstractStatement implements IStatement{
diff --git a/src/org/graphstream/gama/extension/sender/ClearStatement.java b/src/org/graphstream/gama/extension/sender/ClearStatement.java
index 1ca73a4..c26405e 100644
--- a/src/org/graphstream/gama/extension/sender/ClearStatement.java
+++ b/src/org/graphstream/gama/extension/sender/ClearStatement.java
@@ -16,8 +16,15 @@ import msi.gaml.statements.AbstractStatement;
 import msi.gaml.statements.IStatement;
 import msi.gaml.types.IType;
 
-
-
+/**
+ * Implements the {@code gs_clear} command.
+ *
+ * <pre>
+ * gs_clear gs_sender_id:senderId;
+ * </pre>
+ * @author Thibaut Démare
+ *
+ */
 @symbol(name = IKeywordGSAdditional.CLEAR, kind = ISymbolKind.SINGLE_STATEMENT, with_sequence = false)
 @inside(kinds = { ISymbolKind.BEHAVIOR, ISymbolKind.SEQUENCE_STATEMENT, ISymbolKind.LAYER })
 @facets(value = { @facet(name = IKeywordGSAdditional.SENDERID, type = IType.STRING, optional = false) })
diff --git a/src/org/graphstream/gama/extension/sender/CloseStatement.java b/src/org/graphstream/gama/extension/sender/CloseStatement.java
index 31f9ea8..3a22bd4 100644
--- a/src/org/graphstream/gama/extension/sender/CloseStatement.java
+++ b/src/org/graphstream/gama/extension/sender/CloseStatement.java
@@ -16,7 +16,15 @@ import msi.gaml.types.IType;
 import org.graphstream.gama.extension.GSManager;
 import org.graphstream.gama.extension.IKeywordGSAdditional;
 
-
+/**
+ * Implements the {@code gs_close} command.
+ *
+ * <pre>
+ * gs_close gs_sender_id:senderId;
+ * </pre>
+ * @author Thibaut Démare
+ *
+ */
 @symbol(name = IKeywordGSAdditional.CLOSE, kind = ISymbolKind.SINGLE_STATEMENT, with_sequence = false)
 @inside(kinds = { ISymbolKind.BEHAVIOR, ISymbolKind.SEQUENCE_STATEMENT, ISymbolKind.LAYER })
 @facets(value = { @facet(name = IKeywordGSAdditional.SENDERID, type = IType.STRING, optional = false)})
diff --git a/src/org/graphstream/gama/extension/sender/RemoveEdgeAttributeStatement.java b/src/org/graphstream/gama/extension/sender/RemoveEdgeAttributeStatement.java
index 164a183..b481bdf 100644
--- a/src/org/graphstream/gama/extension/sender/RemoveEdgeAttributeStatement.java
+++ b/src/org/graphstream/gama/extension/sender/RemoveEdgeAttributeStatement.java
@@ -16,7 +16,15 @@ import msi.gaml.types.IType;
 import org.graphstream.gama.extension.GSManager;
 import org.graphstream.gama.extension.IKeywordGSAdditional;
 
-
+/**
+ * Implements the {@code gs_remove_edge_attribute} command.
+ *
+ * <pre>
+ * gs_remove_edge_attribute gs_sender_id:senderId gs_edge_id:nodeId;
+ * </pre>
+ * @author Thibaut Démare
+ *
+ */
 @symbol(name = IKeywordGSAdditional.REMOVE_EDGE_ATTRIBUTE, kind = ISymbolKind.SINGLE_STATEMENT, with_sequence = false)
 @inside(kinds = { ISymbolKind.BEHAVIOR, ISymbolKind.SEQUENCE_STATEMENT, ISymbolKind.LAYER })
 @facets(value = { @facet(name = IKeywordGSAdditional.SENDERID, type = IType.STRING, optional = false),
diff --git a/src/org/graphstream/gama/extension/sender/RemoveEdgeStatement.java b/src/org/graphstream/gama/extension/sender/RemoveEdgeStatement.java
index 5f24b22..d79748f 100644
--- a/src/org/graphstream/gama/extension/sender/RemoveEdgeStatement.java
+++ b/src/org/graphstream/gama/extension/sender/RemoveEdgeStatement.java
@@ -16,6 +16,15 @@ import msi.gaml.types.IType;
 import org.graphstream.gama.extension.GSManager;
 import org.graphstream.gama.extension.IKeywordGSAdditional;
 
+/**
+ * Implements the {@code gs_remove_edge} command.
+ *
+ * <pre>
+ * gs_remove_edge gs_sender_id:senderId gs_edge_id:edgeId;
+ * </pre>
+ * @author Thibaut Démare
+ *
+ */
 @symbol(name = IKeywordGSAdditional.REMOVE_EDGE, kind = ISymbolKind.SINGLE_STATEMENT, with_sequence = false)
 @inside(kinds = { ISymbolKind.BEHAVIOR, ISymbolKind.SEQUENCE_STATEMENT, ISymbolKind.LAYER })
 @facets(value = { @facet(name = IKeywordGSAdditional.SENDERID, type = IType.STRING, optional = false),
diff --git a/src/org/graphstream/gama/extension/sender/RemoveGraphAttributeStatement.java b/src/org/graphstream/gama/extension/sender/RemoveGraphAttributeStatement.java
index f4a244b..1440e5c 100644
--- a/src/org/graphstream/gama/extension/sender/RemoveGraphAttributeStatement.java
+++ b/src/org/graphstream/gama/extension/sender/RemoveGraphAttributeStatement.java
@@ -16,7 +16,15 @@ import msi.gaml.types.IType;
 import org.graphstream.gama.extension.GSManager;
 import org.graphstream.gama.extension.IKeywordGSAdditional;
 
-
+/**
+ * Implements the {@code gs_remove_graph_attribute} command.
+ *
+ * <pre>
+ * gs_remove_graph_attribute gs_sender_id:senderId gs_attribute_name:name;
+ * </pre>
+ * @author Thibaut Démare
+ *
+ */
 @symbol(name = IKeywordGSAdditional.REMOVE_GRAPH_ATTRIBUTE, kind = ISymbolKind.SINGLE_STATEMENT, with_sequence = false)
 @inside(kinds = { ISymbolKind.BEHAVIOR, ISymbolKind.SEQUENCE_STATEMENT, ISymbolKind.LAYER })
 @facets(value = { @facet(name = IKeywordGSAdditional.SENDERID, type = IType.STRING, optional = false),
diff --git a/src/org/graphstream/gama/extension/sender/RemoveNodeAttributeStatement.java b/src/org/graphstream/gama/extension/sender/RemoveNodeAttributeStatement.java
index ec10dbb..7557ac4 100644
--- a/src/org/graphstream/gama/extension/sender/RemoveNodeAttributeStatement.java
+++ b/src/org/graphstream/gama/extension/sender/RemoveNodeAttributeStatement.java
@@ -16,7 +16,15 @@ import msi.gaml.types.IType;
 import org.graphstream.gama.extension.GSManager;
 import org.graphstream.gama.extension.IKeywordGSAdditional;
 
-
+/**
+ * Implements the {@code gs_remove_node_attribute} command.
+ *
+ * <pre>
+ * gs_remove_node_attribute gs_sender_id:senderId gs_node_id:nodeId gs_attribute_name:name;
+ * </pre>
+ * @author Thibaut Démare
+ *
+ */
 @symbol(name = IKeywordGSAdditional.REMOVE_NODE_ATTRIBUTE, kind = ISymbolKind.SINGLE_STATEMENT, with_sequence = false)
 @inside(kinds = { ISymbolKind.BEHAVIOR, ISymbolKind.SEQUENCE_STATEMENT, ISymbolKind.LAYER })
 @facets(value = { @facet(name = IKeywordGSAdditional.SENDERID, type = IType.STRING, optional = false),
diff --git a/src/org/graphstream/gama/extension/sender/RemoveNodeStatement.java b/src/org/graphstream/gama/extension/sender/RemoveNodeStatement.java
index 7b16aee..a801282 100644
--- a/src/org/graphstream/gama/extension/sender/RemoveNodeStatement.java
+++ b/src/org/graphstream/gama/extension/sender/RemoveNodeStatement.java
@@ -16,6 +16,15 @@ import msi.gaml.types.IType;
 import org.graphstream.gama.extension.GSManager;
 import org.graphstream.gama.extension.IKeywordGSAdditional;
 
+/**
+ * Implements the {@code gs_remove_node} command.
+ *
+ * <pre>
+ * gs_remove_node gs_sender_id:senderId gs_node_id:nodeId;
+ * </pre>
+ * @author Thibaut Démare
+ *
+ */
 @symbol(name = IKeywordGSAdditional.REMOVE_NODE, kind = ISymbolKind.SINGLE_STATEMENT, with_sequence = false)
 @inside(kinds = { ISymbolKind.BEHAVIOR, ISymbolKind.SEQUENCE_STATEMENT, ISymbolKind.LAYER })
 @facets(value = { @facet(name = IKeywordGSAdditional.SENDERID, type = IType.STRING, optional = false),
diff --git a/src/org/graphstream/gama/extension/sender/StepStatement.java b/src/org/graphstream/gama/extension/sender/StepStatement.java
index 0df0eda..1ad5cae 100644
--- a/src/org/graphstream/gama/extension/sender/StepStatement.java
+++ b/src/org/graphstream/gama/extension/sender/StepStatement.java
@@ -16,7 +16,15 @@ import msi.gaml.types.IType;
 import org.graphstream.gama.extension.GSManager;
 import org.graphstream.gama.extension.IKeywordGSAdditional;
 
-
+/**
+ * Implements the {@code gs_step} command.
+ *
+ * <pre>
+ * gs_step gs_sender_id:senderId gs_step_number:number;
+ * </pre>
+ * @author Thibaut Démare
+ *
+ */
 @symbol(name = IKeywordGSAdditional.STEP, kind = ISymbolKind.SINGLE_STATEMENT, with_sequence = false)
 @inside(kinds = { ISymbolKind.BEHAVIOR, ISymbolKind.SEQUENCE_STATEMENT, ISymbolKind.LAYER })
 @facets(value = { @facet(name = IKeywordGSAdditional.SENDERID, type = IType.STRING, optional = false),
-- 
GitLab