TUSCANY-2837 - Adding javadoc comments to JavascriptProxyFactory

git-svn-id: http://svn.us.apache.org/repos/asf/tuscany@759056 13f79535-47bb-0310-9956-ffa450edef68

1 files changed, 20 insertions, 0 deletions

diff --git a/branches/sca-java-1.x/modules/core-web/src/main/java/org/apache/tuscany/sca/core/web/JavascriptProxyFactory.java b/branches/sca-java-1.x/modules/core-web/src/main/java/org/apache/tuscany/sca/core/web/JavascriptProxyFactory.java
index e8009383c3..b6a0662a47 100644
--- a/branches/sca-java-1.x/modules/core-web/src/main/java/org/apache/tuscany/sca/core/web/JavascriptProxyFactory.java
+++ b/branches/sca-java-1.x/modules/core-web/src/main/java/org/apache/tuscany/sca/core/web/JavascriptProxyFactory.java
@@ -25,11 +25,31 @@ import javax.xml.namespace.QName;
 
 import org.apache.tuscany.sca.assembly.ComponentReference;
 
+/**
+ * Javascript Proxy Factory used to allow Web related bindings to generate 
+ * client js proxyies
+ * 
+ * @version $Rev$ $Date$
+ */
 public interface JavascriptProxyFactory {
 
+    /**
+     * The binding model type associated with this factory
+     * @return the binding model type
+     */
     Class<?> getModelType(); 
     
+    /**
+     * The binding qname associated with this factory
+     * @return the binding qname
+     */
     QName getQName();
     
+    /**
+     * Create a JavaScript Proxy for a given reference
+     * @param componentReference The reference
+     * @return the javascript proxy code
+     * @throws IOException
+     */
     String scriptReference(ComponentReference componentReference) throws IOException;
 }