javadoc for webservice client tutorial

[jalview.git] / src / jalview / ws / WSClient.java

diff --git a/src/jalview/ws/WSClient.java b/src/jalview/ws/WSClient.java
index 8c9acb5..cf871b8 100755 (executable)
--- a/src/jalview/ws/WSClient.java
+++ b/src/jalview/ws/WSClient.java
@@ -24,17 +24,35 @@ import jalview.gui.*;
 public class WSClient
 {
   /**
-   * MsaWSClient
-   *
-   * @param msa SequenceI[]
+   * WSClient holds the basic attributes that are displayed to the user
+   * for all jalview web service clients
+   */
+  /**
+   * displayed name for this web service
    */
   protected String WebServiceName;
+  /**
+   * specific job title (e.g. 'ClustalW Alignment of Selection from Aligment from Cut and Paste input')
+   */
   protected String WebServiceJobTitle;
+  /**
+   * String giving additional information such as method citations for this service 
+   */
   protected String WebServiceReference;
+  /**
+   * Service endpoint
+   */
   protected String WsURL;
+  /**
+   * Web service information used to initialise the WSClient attributes
+   */
   protected WebserviceInfo wsInfo;
+  /**
+   * total number of jobs managed by this web service client instance. 
+   */
   int jobsRunning = 0;
   /**
+   * TODO: this is really service metadata, and should be moved elsewhere.
    * mappings between abstract interface names and menu entries
    */
   protected java.util.Hashtable ServiceActions;
@@ -46,7 +64,11 @@ public class WSClient
   public WSClient()
   {
   }
-
+  /**
+   * initialise WSClient service information attributes from the service handle
+   * @param sh
+   * @return the service instance information for this client and job.
+   */
   protected WebserviceInfo setWebService(ServiceHandle sh)
   {
     WebServiceName = sh.getName();