Merge pull request #548 from muditporwal/master

Checkstyle improvements #539 : Added JavaDocType Rule

guarded-suspension/src/main/java/com/iluwatar/guarded/suspension/GuardedQueue.java

@@ -28,7 +28,12 @@ import org.slf4j.LoggerFactory;
 import java.util.LinkedList;
 import java.util.Queue;
 
-
+/**
+ * Guarded Queue is an implementation for Guarded Suspension Pattern
+ * Guarded suspension pattern is used to handle a situation when you want to execute a method
+ * on an object which is not in a proper state.
+ * @see http://java-design-patterns.com/patterns/guarded-suspension/
+ */
 public class GuardedQueue {
   private static final Logger LOGGER = LoggerFactory.getLogger(GuardedQueue.class);
   private final Queue<Integer> sourceList;

guarded-suspension/src/test/java/com/iluwatar/guarded/suspension/GuardedQueueTest.java

@@ -29,6 +29,9 @@ import java.util.concurrent.ExecutorService;
 import java.util.concurrent.Executors;
 import java.util.concurrent.TimeUnit;
 
+/**
+ * Test for Guarded Queue
+ */
 public class GuardedQueueTest {
   private volatile Integer value;
 
@@ -55,4 +58,4 @@ public class GuardedQueueTest {
 
   }
 
-}
+}