1 files changed, 14 insertions, 0 deletions
diff --git a/sca-java-2.x/contrib/modules/binding-websocket/src/main/java/org/apache/tuscany/sca/binding/websocket/runtime/JavascriptGenerator.java b/sca-java-2.x/contrib/modules/binding-websocket/src/main/java/org/apache/tuscany/sca/binding/websocket/runtime/JavascriptGenerator.java
index 04faf0113d..21b953151b 100644
--- a/sca-java-2.x/contrib/modules/binding-websocket/src/main/java/org/apache/tuscany/sca/binding/websocket/runtime/JavascriptGenerator.java
+++ b/sca-java-2.x/contrib/modules/binding-websocket/src/main/java/org/apache/tuscany/sca/binding/websocket/runtime/JavascriptGenerator.java
@@ -42,12 +42,20 @@ import java.util.List;
 
 import org.apache.tuscany.sca.interfacedef.Operation;
 
+/**
+ * Generates javascript service proxies using the websocket API. This enables
+ * simulating SCA on the client side javascript. This is a stateful singleton.
+ */
 public class JavascriptGenerator {
 
     private final static String CONTEXT = "this.WebsocketComponentContext";
     private static final String LF = "\n";
     private static StringBuilder builder = new StringBuilder();
 
+    /**
+     * Generate javascript code for one service and all it's operations. Add
+     * this to the state of the generator.
+     */
     public static void generateServiceProxy(String component, String service, List<Operation> operations, int port) {
         if (builder.length() == 0) {
             builder.append(CONTEXT).append("={};").append(LF);
@@ -85,10 +93,16 @@ public class JavascriptGenerator {
         return content;
     }
 
+    /**
+     * Get the state of the generator.
+     */
     public static String getServiceProxies() {
         return builder.toString();
     }
 
+    /**
+     * Reset the state of the generator.
+     */
     public static void clear() {
         builder.setLength(0);
     }