iluwatar#107 JavaDoc improvements for Async Method Invocation example

iluwatar · iluwatar · commit 8d621566833d · 2015-08-18T21:11:39.000+03:00
diff --git a/async-method-invocation/src/main/java/com/iluwatar/async/method/invocation/App.java b/async-method-invocation/src/main/java/com/iluwatar/async/method/invocation/App.java
@@ -3,29 +3,24 @@
 import java.util.concurrent.Callable;
 
 /**
- * <p>
  * This application demonstrates the async method invocation pattern. Key parts of the pattern are
  * <code>AsyncResult</code> which is an intermediate container for an asynchronously evaluated value,
  * <code>AsyncCallback</code> which can be provided to be executed on task completion and
  * <code>AsyncExecutor</code> that manages the execution of the async tasks.
- * </p>
  * <p>
  * The main method shows example flow of async invocations. The main thread starts multiple tasks with
  * variable durations and then continues its own work. When the main thread has done it's job it collects
  * the results of the async tasks. Two of the tasks are handled with callbacks, meaning the callbacks are
  * executed immediately when the tasks complete.
- * </p>
  * <p>
  * Noteworthy difference of thread usage between the async results and callbacks is that the async results
  * are collected in the main thread but the callbacks are executed within the worker threads. This should be
  * noted when working with thread pools.
- * </p>
  * <p>
  * Java provides its own implementations of async method invocation pattern. FutureTask, CompletableFuture
  * and ExecutorService are the real world implementations of this pattern. But due to the nature of parallel
  * programming, the implementations are not trivial. This example does not take all possible scenarios into
  * account but rather provides a simple version that helps to understand the pattern.
- * </p>
  *
  * @see AsyncResult
  * @see AsyncCallback
diff --git a/async-method-invocation/src/main/java/com/iluwatar/async/method/invocation/AsyncCallback.java b/async-method-invocation/src/main/java/com/iluwatar/async/method/invocation/AsyncCallback.java
@@ -2,6 +2,13 @@
 
 import java.util.Optional;
 
+/**
+ * 
+ * AsyncCallback interface
+ *
+ * @param <T>
+ * 
+ */
 public interface AsyncCallback<T> {
 
 	/**
diff --git a/async-method-invocation/src/main/java/com/iluwatar/async/method/invocation/AsyncExecutor.java b/async-method-invocation/src/main/java/com/iluwatar/async/method/invocation/AsyncExecutor.java
@@ -3,6 +3,11 @@
 import java.util.concurrent.Callable;
 import java.util.concurrent.ExecutionException;
 
+/**
+ * 
+ * AsyncExecutor interface
+ *
+ */
 public interface AsyncExecutor {
 
 	/**
diff --git a/async-method-invocation/src/main/java/com/iluwatar/async/method/invocation/AsyncResult.java b/async-method-invocation/src/main/java/com/iluwatar/async/method/invocation/AsyncResult.java
@@ -2,6 +2,12 @@
 
 import java.util.concurrent.ExecutionException;
 
+/**
+ * 
+ * AsyncResult interface
+ *
+ * @param <T>
+ */
 public interface AsyncResult<T> {
 
 	/**
diff --git a/async-method-invocation/src/main/java/com/iluwatar/async/method/invocation/ThreadAsyncExecutor.java b/async-method-invocation/src/main/java/com/iluwatar/async/method/invocation/ThreadAsyncExecutor.java
@@ -6,7 +6,9 @@
 import java.util.concurrent.atomic.AtomicInteger;
 
 /**
+ * 
  * Implementation of async executor that creates a new thread for every task.
+ * 
  */
 public class ThreadAsyncExecutor implements AsyncExecutor {
 
