Gui Modifications for Service Discovery.

[jalview.git] / src / jalview / gui / WebserviceInfo.java

diff --git a/src/jalview/gui/WebserviceInfo.java b/src/jalview/gui/WebserviceInfo.java
index 5241ec4..a260072 100755 (executable)
--- a/src/jalview/gui/WebserviceInfo.java
+++ b/src/jalview/gui/WebserviceInfo.java
@@ -27,29 +27,29 @@ import javax.swing.*;
 \r
 \r
 /**\r
- * DOCUMENT ME!\r
+ * Base class for web service client thread and gui\r
  *\r
  * @author $author$\r
  * @version $Revision$\r
  */\r
 public class WebserviceInfo extends GWebserviceInfo\r
 {\r
-    /** DOCUMENT ME!! */\r
+    /** Job is Queued */\r
     public static final int STATE_QUEUING = 0;\r
 \r
-    /** DOCUMENT ME!! */\r
+    /** Job is Running */\r
     public static final int STATE_RUNNING = 1;\r
 \r
-    /** DOCUMENT ME!! */\r
+    /** Job has finished with no errors */\r
     public static final int STATE_STOPPED_OK = 2;\r
 \r
-    /** DOCUMENT ME!! */\r
+    /** Job has been cancelled with no errors */\r
     public static final int STATE_CANCELLED_OK = 3;\r
 \r
-    /** DOCUMENT ME!! */\r
+    /** job has stopped because of some error */\r
     public static final int STATE_STOPPED_ERROR = 4;\r
 \r
-    /** DOCUMENT ME!! */\r
+    /** job has failed because of some unavoidable service interruption */\r
     public static final int STATE_STOPPED_SERVERERROR = 5;\r
     int currentStatus = STATE_QUEUING;\r
     Image image;\r
@@ -61,8 +61,8 @@ public class WebserviceInfo extends GWebserviceInfo
     /**\r
      * Creates a new WebserviceInfo object.\r
      *\r
-     * @param title DOCUMENT ME!\r
-     * @param info DOCUMENT ME!\r
+     * @param title short name and job type\r
+     * @param info reference or other human readable description\r
      */\r
     public WebserviceInfo(String title, String info)\r
     {\r
@@ -144,7 +144,7 @@ public class WebserviceInfo extends GWebserviceInfo
     /**\r
      * DOCUMENT ME!\r
      *\r
-     * @param status DOCUMENT ME!\r
+     * @param status integer status from state constants\r
      */\r
     public void setStatus(int status)\r
     {\r
@@ -212,7 +212,7 @@ public class WebserviceInfo extends GWebserviceInfo
     }\r
 \r
     /**\r
-     * DOCUMENT ME!\r
+     * Gui action for cancelling the current job, if possible.\r
      *\r
      * @param e DOCUMENT ME!\r
      */\r
@@ -221,7 +221,7 @@ public class WebserviceInfo extends GWebserviceInfo
         if (!serviceIsCancellable)\r
         {\r
             JOptionPane.showInternalMessageDialog(Desktop.desktop,\r
-                "This job cannot be cancelled.", "Cancel job",\r
+                "This job cannot be cancelled.\nJust close the window.", "Cancel job",\r
                 JOptionPane.WARNING_MESSAGE);\r
         }\r
         else\r