JAL-3878 Provide javadoc for WebServiceClientI interface

diff --git a/src/jalview/ws2/client/api/WebServiceClientI.java b/src/jalview/ws2/client/api/WebServiceClientI.java
index f788442..e62909e 100644 (file)
--- a/src/jalview/ws2/client/api/WebServiceClientI.java
+++ b/src/jalview/ws2/client/api/WebServiceClientI.java
@@ -8,6 +8,17 @@ import jalview.ws.params.ArgumentI;
 import jalview.ws2.api.Credentials;
 import jalview.ws2.api.WebServiceJob;
 
+/**
+ * A common interface for all web service clients that provide methods to
+ * get the URL of the server the client is talking to, submit new jobs to the
+ * server as well as poll or cancel the running jobs. This interface does not
+ * provide means to retrieve job results as those may differ between
+ * web services. Specialized sub-interfaces define methods to retrieve job
+ * results appropriate for specific service types.
+ * 
+ * @author mmwarowny
+ *
+ */
 public interface WebServiceClientI
 {
   /**