Add javadoc on use of AsynchronousTaskExecutor.

zanata · Aug 26, 2013 · 235bba8 · 235bba8
1 parent d65f05a
commit 235bba8
Showing 1 changed file with 3 additions and 1 deletion.
diff --git a/zanata-war/src/main/java/org/zanata/async/AsynchronousTaskExecutor.java b/zanata-war/src/main/java/org/zanata/async/AsynchronousTaskExecutor.java
@@ -34,7 +34,9 @@
 
 /**
  * This class executes a Runnable Process asynchronously. Do not use this class directly.
- * Use {@link org.zanata.async.TaskExecutor} instead.
+ * Use {@link org.zanata.async.TaskExecutor} instead as this is just a wrapper to make sure
+ * Seam can run the task in the background. {@link TaskExecutor} is able to do this as well as
+ * return an instance of the task handle to keep track of the task's progress.
  *
  * @author Carlos Munoz <a href="mailto:camunoz@redhat.com">camunoz@redhat.com</a>
  */