JAL-3878 Add javadocs to created classes and reformat code.

[jalview.git] / src / jalview / ws2 / WebServiceInfoUpdater.java

diff --git a/src/jalview/ws2/WebServiceInfoUpdater.java b/src/jalview/ws2/WebServiceInfoUpdater.java
index c9557c6..a4d0f70 100644 (file)
--- a/src/jalview/ws2/WebServiceInfoUpdater.java
+++ b/src/jalview/ws2/WebServiceInfoUpdater.java
@@ -6,6 +6,17 @@ import java.util.Objects;
 
 import jalview.gui.WebserviceInfo;
 
+/**
+ * A helper class that can be attached as a listener to the {@link WSJob}
+ * object. It updates the job status in the {@link jalview.gui.WebServiceInfo}
+ * window according to the state changes of the job object.
+ * 
+ * The {@link WebServiceInfoUpdater} object allows to decouple GUI updates
+ * from the web service worker logic.
+ * 
+ * @author mmwarowny
+ *
+ */
 public class WebServiceInfoUpdater implements PropertyChangeListener
 {
   private final WebServiceWorkerI worker;