Merge branch 'javadoc'

abstract-factory/src/main/java/com/iluwatar/abstractfactory/App.java

@@ -3,20 +3,28 @@ package com.iluwatar.abstractfactory;
 /**
  * 
  * The essence of the Abstract Factory pattern is a factory interface
- * (KingdomFactory) and its implementations (ElfKingdomFactory,
+ * ({@link KingdomFactory}) and its implementations ({@link ElfKingdomFactory},
- * OrcKingdomFactory).
+ * {@link OrcKingdomFactory}).
- * 
+ * <p>
  * The example uses both concrete implementations to create a king, a castle and
  * an army.
  * 
  */
 public class App {
 
+	/**
+	 * Program entry point
+	 * @param args command line arguments
+	 */
 	public static void main(String[] args) {
 		createKingdom(new ElfKingdomFactory());
 		createKingdom(new OrcKingdomFactory());
 	}
 
+	/**
+	 * Creates kingdom
+	 * @param factory
+	 */
 	public static void createKingdom(KingdomFactory factory) {
 		King king = factory.createKing();
 		Castle castle = factory.createCastle();

abstract-factory/src/main/java/com/iluwatar/abstractfactory/Army.java

@@ -1,5 +1,10 @@
 package com.iluwatar.abstractfactory;
 
+/**
+ * 
+ * Army interface
+ *
+ */
 public interface Army {
 
 }

abstract-factory/src/main/java/com/iluwatar/abstractfactory/Castle.java

@@ -1,5 +1,10 @@
 package com.iluwatar.abstractfactory;
 
+/**
+ * 
+ * Castle interface
+ *
+ */
 public interface Castle {
 
 }

abstract-factory/src/main/java/com/iluwatar/abstractfactory/ElfArmy.java

@@ -1,5 +1,10 @@
 package com.iluwatar.abstractfactory;
 
+/**
+ * 
+ * ElfArmy
+ *
+ */
 public class ElfArmy implements Army {
 
 	@Override

abstract-factory/src/main/java/com/iluwatar/abstractfactory/ElfCastle.java

@@ -1,5 +1,10 @@
 package com.iluwatar.abstractfactory;
 
+/**
+ * 
+ * ElfCastle
+ *
+ */
 public class ElfCastle implements Castle {
 
 	@Override

abstract-factory/src/main/java/com/iluwatar/abstractfactory/ElfKing.java

@@ -1,5 +1,10 @@
 package com.iluwatar.abstractfactory;
 
+/**
+ * 
+ * ElfKing
+ *
+ */
 public class ElfKing implements King {
 
 	@Override

abstract-factory/src/main/java/com/iluwatar/abstractfactory/ElfKingdomFactory.java

@@ -2,7 +2,7 @@ package com.iluwatar.abstractfactory;
 
 /**
  * 
- * Concrete factory.
+ * ElfKingdomFactory concrete factory.
  * 
  */
 public class ElfKingdomFactory implements KingdomFactory {

abstract-factory/src/main/java/com/iluwatar/abstractfactory/King.java

@@ -1,5 +1,10 @@
 package com.iluwatar.abstractfactory;
 
+/**
+ * 
+ * King interface
+ *
+ */
 public interface King {
 
 }

abstract-factory/src/main/java/com/iluwatar/abstractfactory/KingdomFactory.java

@@ -2,7 +2,7 @@ package com.iluwatar.abstractfactory;
 
 /**
  * 
- * The factory interface.
+ * KingdomFactory factory interface.
  * 
  */
 public interface KingdomFactory {

abstract-factory/src/main/java/com/iluwatar/abstractfactory/OrcArmy.java

@@ -1,5 +1,10 @@
 package com.iluwatar.abstractfactory;
 
+/**
+ * 
+ * OrcArmy
+ *
+ */
 public class OrcArmy implements Army {
 
 	@Override

abstract-factory/src/main/java/com/iluwatar/abstractfactory/OrcCastle.java

@@ -1,5 +1,10 @@
 package com.iluwatar.abstractfactory;
 
+/**
+ * 
+ * OrcCastle
+ *
+ */
 public class OrcCastle implements Castle {
 
 	@Override

abstract-factory/src/main/java/com/iluwatar/abstractfactory/OrcKing.java

@@ -1,5 +1,10 @@
 package com.iluwatar.abstractfactory;
 
+/**
+ * 
+ * OrcKing
+ *
+ */
 public class OrcKing implements King {
 
 	@Override

abstract-factory/src/main/java/com/iluwatar/abstractfactory/OrcKingdomFactory.java

@@ -2,7 +2,7 @@ package com.iluwatar.abstractfactory;
 
 /**
  * 
- * Concrete factory.
+ * OrcKingdomFactory concrete factory.
  * 
  */
 public class OrcKingdomFactory implements KingdomFactory {

abstract-factory/src/test/java/com/iluwatar/abstractfactory/AppTest.java

@@ -3,6 +3,11 @@ import org.junit.Test;
 
 import com.iluwatar.abstractfactory.App;
 
+/**
+ * 
+ * Application test
+ *
+ */
 public class AppTest {
 
 	@Test

adapter/src/main/java/com/iluwatar/adapter/App.java

@@ -6,14 +6,18 @@ package com.iluwatar.adapter;
  * the adaptee's interface whereas the object adapter uses composition to
  * contain the adaptee in the adapter object. This example uses the object
  * adapter approach.
- * 
+ * <p>
- * The Adapter (GnomeEngineer) converts the interface of the target class
+ * The Adapter ({@link GnomeEngineer}) converts the interface of the target class
- * (GoblinGlider) into a suitable one expected by the client
+ * ({@link GoblinGlider}) into a suitable one expected by the client
- * (GnomeEngineeringManager).
+ * ({@link GnomeEngineeringManager}).
  * 
  */
 public class App {
 
+	/**
+	 * Program entry point
+	 * @param args command line args
+	 */
 	public static void main(String[] args) {
 		Engineer manager = new GnomeEngineeringManager();
 		manager.operateDevice();

adapter/src/main/java/com/iluwatar/adapter/GnomeEngineer.java

@@ -2,8 +2,8 @@ package com.iluwatar.adapter;
 
 /**
  * 
- * Adapter class. Adapts the interface of the device (GoblinGlider) into
+ * Adapter class. Adapts the interface of the device ({@link GoblinGlider}) into
- * Engineer interface expected by the client (GnomeEngineeringManager).
+ * {@link Engineer} interface expected by the client ({@link GnomeEngineeringManager}).
  * 
  */
 public class GnomeEngineer implements Engineer {

adapter/src/main/java/com/iluwatar/adapter/GnomeEngineeringManager.java

@@ -2,7 +2,7 @@ package com.iluwatar.adapter;
 
 /**
  * 
- * GnomeEngineering manager uses Engineer to operate devices.
+ * GnomeEngineering manager uses {@link Engineer} to operate devices.
  * 
  */
 public class GnomeEngineeringManager implements Engineer {

adapter/src/test/java/com/iluwatar/adapter/AppTest.java

@@ -4,6 +4,11 @@ import org.junit.Test;
 
 import com.iluwatar.adapter.App;
 
+/**
+ * 
+ * Application test
+ *
+ */
 public class AppTest {
 
 	@Test

async-method-invocation/src/main/java/com/iluwatar/async/method/invocation/App.java

@@ -3,29 +3,24 @@ package com.iluwatar.async.method.invocation;
 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

async-method-invocation/src/main/java/com/iluwatar/async/method/invocation/AsyncCallback.java

@@ -2,6 +2,13 @@ package com.iluwatar.async.method.invocation;
 
 import java.util.Optional;
 
+/**
+ * 
+ * AsyncCallback interface
+ *
+ * @param <T>
+ * 
+ */
 public interface AsyncCallback<T> {
 
 	/**

async-method-invocation/src/main/java/com/iluwatar/async/method/invocation/AsyncExecutor.java

@@ -3,6 +3,11 @@ package com.iluwatar.async.method.invocation;
 import java.util.concurrent.Callable;
 import java.util.concurrent.ExecutionException;
 
+/**
+ * 
+ * AsyncExecutor interface
+ *
+ */
 public interface AsyncExecutor {
 
 	/**

async-method-invocation/src/main/java/com/iluwatar/async/method/invocation/AsyncResult.java

@@ -2,6 +2,12 @@ package com.iluwatar.async.method.invocation;
 
 import java.util.concurrent.ExecutionException;
 
+/**
+ * 
+ * AsyncResult interface
+ *
+ * @param <T>
+ */
 public interface AsyncResult<T> {
 
 	/**

async-method-invocation/src/main/java/com/iluwatar/async/method/invocation/ThreadAsyncExecutor.java

@@ -6,7 +6,9 @@ import java.util.concurrent.ExecutionException;
 import java.util.concurrent.atomic.AtomicInteger;
 
 /**
+ * 
  * Implementation of async executor that creates a new thread for every task.
+ * 
  */
 public class ThreadAsyncExecutor implements AsyncExecutor {
 

async-method-invocation/src/test/java/com/iluwatar/async/method/invocation/AppTest.java

@@ -2,6 +2,11 @@ package com.iluwatar.async.method.invocation;
 
 import org.junit.Test;
 
+/**
+ * 
+ * Application test
+ *
+ */
 public class AppTest {
 
 	@Test

bridge/etc/bridge.ucls

@@ -1,18 +1,18 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <class-diagram version="1.1.8" icons="true" automaticImage="PNG" always-add-relationships="false" generalizations="true" 
   realizations="true" associations="true" dependencies="false" nesting-relationships="true">  
-  <class id="1" language="java" name="com.iluwatar.bridge.FlyingMagicWeaponImp" project="bridge" 
+  <class id="1" language="java" name="com.iluwatar.bridge.FlyingMagicWeaponImpl" project="bridge" 
-    file="/bridge/src/main/java/com/iluwatar/bridge/FlyingMagicWeaponImp.java" binary="false" corner="BOTTOM_RIGHT">    
+    file="/bridge/src/main/java/com/iluwatar/bridge/FlyingMagicWeaponImpl.java" binary="false" corner="BOTTOM_RIGHT">    
-    <position height="105" width="192" x="193" y="297"/>    
+    <position height="-1" width="-1" x="515" y="591"/>    
     <display autosize="true" stereotype="true" package="true" initial-value="false" signature="true" 
       sort-features="false" accessors="true" visibility="true">      
       <attributes public="true" package="true" protected="true" private="true" static="true"/>      
       <operations public="true" package="true" protected="true" private="true" static="true"/>    
     </display>  
   </class>  
-  <class id="2" language="java" name="com.iluwatar.bridge.SoulEatingMagicWeaponImp" project="bridge" 
+  <class id="2" language="java" name="com.iluwatar.bridge.SoulEatingMagicWeaponImpl" project="bridge" 
-    file="/bridge/src/main/java/com/iluwatar/bridge/SoulEatingMagicWeaponImp.java" binary="false" corner="BOTTOM_RIGHT">    
+    file="/bridge/src/main/java/com/iluwatar/bridge/SoulEatingMagicWeaponImpl.java" binary="false" corner="BOTTOM_RIGHT">    
-    <position height="105" width="226" x="425" y="297"/>    
+    <position height="-1" width="-1" x="791" y="605"/>    
     <display autosize="true" stereotype="true" package="true" initial-value="false" signature="true" 
       sort-features="false" accessors="true" visibility="true">      
       <attributes public="true" package="true" protected="true" private="true" static="true"/>      
@@ -21,25 +21,25 @@
   </class>  
   <class id="3" language="java" name="com.iluwatar.bridge.Stormbringer" project="bridge" 
     file="/bridge/src/main/java/com/iluwatar/bridge/Stormbringer.java" binary="false" corner="BOTTOM_RIGHT">    
-    <position height="160" width="125" x="425" y="442"/>    
+    <position height="-1" width="-1" x="791" y="788"/>    
     <display autosize="true" stereotype="true" package="true" initial-value="false" signature="true" 
       sort-features="false" accessors="true" visibility="true">      
       <attributes public="true" package="true" protected="true" private="true" static="true"/>      
       <operations public="true" package="true" protected="true" private="true" static="true"/>    
     </display>  
   </class>  
-  <class id="4" language="java" name="com.iluwatar.bridge.MagicWeaponImp" project="bridge" 
+  <class id="4" language="java" name="com.iluwatar.bridge.MagicWeaponImpl" project="bridge" 
-    file="/bridge/src/main/java/com/iluwatar/bridge/MagicWeaponImp.java" binary="false" corner="BOTTOM_RIGHT">    
+    file="/bridge/src/main/java/com/iluwatar/bridge/MagicWeaponImpl.java" binary="false" corner="BOTTOM_RIGHT">    
-    <position height="141" width="149" x="221" y="79"/>    
+    <position height="-1" width="-1" x="791" y="433"/>    
     <display autosize="true" stereotype="true" package="true" initial-value="false" signature="true" 
       sort-features="false" accessors="true" visibility="true">      
       <attributes public="true" package="true" protected="true" private="true" static="true"/>      
       <operations public="true" package="true" protected="true" private="true" static="true"/>    
     </display>  
   </class>  
-  <class id="5" language="java" name="com.iluwatar.bridge.BlindingMagicWeaponImp" project="bridge" 
+  <class id="5" language="java" name="com.iluwatar.bridge.BlindingMagicWeaponImpl" project="bridge" 
-    file="/bridge/src/main/java/com/iluwatar/bridge/BlindingMagicWeaponImp.java" binary="false" corner="BOTTOM_RIGHT">    
+    file="/bridge/src/main/java/com/iluwatar/bridge/BlindingMagicWeaponImpl.java" binary="false" corner="BOTTOM_RIGHT">    
-    <position height="105" width="208" x="691" y="297"/>    
+    <position height="-1" width="-1" x="1105" y="593"/>    
     <display autosize="true" stereotype="true" package="true" initial-value="false" signature="true" 
       sort-features="false" accessors="true" visibility="true">      
       <attributes public="true" package="true" protected="true" private="true" static="true"/>      
@@ -48,7 +48,7 @@
   </class>  
   <class id="6" language="java" name="com.iluwatar.bridge.SoulEatingMagicWeapon" project="bridge" 
     file="/bridge/src/main/java/com/iluwatar/bridge/SoulEatingMagicWeapon.java" binary="false" corner="BOTTOM_RIGHT">    
-    <position height="178" width="347" x="410" y="79"/>    
+    <position height="-1" width="-1" x="380" y="21"/>    
     <display autosize="true" stereotype="true" package="true" initial-value="false" signature="true" 
       sort-features="false" accessors="true" visibility="true">      
       <attributes public="true" package="true" protected="true" private="true" static="true"/>      
@@ -57,7 +57,7 @@
   </class>  
   <class id="7" language="java" name="com.iluwatar.bridge.Excalibur" project="bridge" 
     file="/bridge/src/main/java/com/iluwatar/bridge/Excalibur.java" binary="false" corner="BOTTOM_RIGHT">    
-    <position height="160" width="124" x="691" y="442"/>    
+    <position height="-1" width="-1" x="1105" y="782"/>    
     <display autosize="true" stereotype="true" package="true" initial-value="false" signature="true" 
       sort-features="false" accessors="true" visibility="true">      
       <attributes public="true" package="true" protected="true" private="true" static="true"/>      
@@ -66,7 +66,7 @@
   </class>  
   <class id="8" language="java" name="com.iluwatar.bridge.Mjollnir" project="bridge" 
     file="/bridge/src/main/java/com/iluwatar/bridge/Mjollnir.java" binary="false" corner="BOTTOM_RIGHT">    
-    <position height="160" width="124" x="193" y="442"/>    
+    <position height="-1" width="-1" x="515" y="788"/>    
     <display autosize="true" stereotype="true" package="true" initial-value="false" signature="true" 
       sort-features="false" accessors="true" visibility="true">      
       <attributes public="true" package="true" protected="true" private="true" static="true"/>      
@@ -75,7 +75,7 @@
   </class>  
   <class id="9" language="java" name="com.iluwatar.bridge.BlindingMagicWeapon" project="bridge" 
     file="/bridge/src/main/java/com/iluwatar/bridge/BlindingMagicWeapon.java" binary="false" corner="BOTTOM_RIGHT">    
-    <position height="178" width="313" x="797" y="79"/>    
+    <position height="-1" width="-1" x="791" y="14"/>    
     <display autosize="true" stereotype="true" package="true" initial-value="false" signature="true" 
       sort-features="false" accessors="true" visibility="true">      
       <attributes public="true" package="true" protected="true" private="true" static="true"/>      
@@ -84,7 +84,7 @@
   </class>  
   <class id="10" language="java" name="com.iluwatar.bridge.MagicWeapon" project="bridge" 
     file="/bridge/src/main/java/com/iluwatar/bridge/MagicWeapon.java" binary="false" corner="BOTTOM_RIGHT">    
-    <position height="159" width="221" x="644" y="-120"/>    
+    <position height="-1" width="-1" x="791" y="237"/>    
     <display autosize="true" stereotype="true" package="true" initial-value="false" signature="true" 
       sort-features="false" accessors="true" visibility="true">      
       <attributes public="true" package="true" protected="true" private="true" static="true"/>      
@@ -93,7 +93,7 @@
   </class>  
   <class id="11" language="java" name="com.iluwatar.bridge.FlyingMagicWeapon" project="bridge" 
     file="/bridge/src/main/java/com/iluwatar/bridge/FlyingMagicWeapon.java" binary="false" corner="BOTTOM_RIGHT">    
-    <position height="178" width="291" x="1150" y="79"/>    
+    <position height="-1" width="-1" x="1144" y="12"/>    
     <display autosize="true" stereotype="true" package="true" initial-value="false" signature="true" 
       sort-features="false" accessors="true" visibility="true">      
       <attributes public="true" package="true" protected="true" private="true" static="true"/>      
@@ -101,48 +101,52 @@
     </display>  
   </class>  
   <generalization id="12">    
-    <end type="SOURCE" refId="11"/>    
+    <end type="SOURCE" refId="8"/>    
-    <end type="TARGET" refId="10"/>  
+    <end type="TARGET" refId="1"/>  
   </generalization>  
   <generalization id="13">    
     <end type="SOURCE" refId="1"/>    
     <end type="TARGET" refId="4"/>  
   </generalization>  
   <generalization id="14">    
-    <end type="SOURCE" refId="2"/>    
-    <end type="TARGET" refId="4"/>  
-  </generalization>  
-  <generalization id="15">    
-    <end type="SOURCE" refId="7"/>    
-    <end type="TARGET" refId="5"/>  
-  </generalization>  
-  <generalization id="16">    
-    <end type="SOURCE" refId="6"/>    
-    <end type="TARGET" refId="10"/>  
-  </generalization>  
-  <generalization id="17">    
     <end type="SOURCE" refId="9"/>    
     <end type="TARGET" refId="10"/>  
   </generalization>  
-  <generalization id="18">    
+  <generalization id="15">    
-    <end type="SOURCE" refId="3"/>    
+    <end type="SOURCE" refId="2"/>    
-    <end type="TARGET" refId="2"/>  
+    <end type="TARGET" refId="4"/>  
   </generalization>  
-  <association id="19">    
+  <association id="16">    
     <end type="SOURCE" refId="10" navigable="false">      
-      <attribute id="20" name="imp"/>      
+      <attribute id="17" name="imp">        
-      <multiplicity id="21" minimum="0" maximum="1"/>    
+        <position height="0" width="0" x="478" y="284"/>      
+      </attribute>      
+      <multiplicity id="18" minimum="0" maximum="1">        
+        <position height="0" width="0" x="478" y="284"/>      
+      </multiplicity>    
     </end>    
     <end type="TARGET" refId="4" navigable="true"/>    
     <display labels="true" multiplicity="true"/>  
   </association>  
-  <generalization id="22">    
+  <generalization id="19">    
     <end type="SOURCE" refId="5"/>    
     <end type="TARGET" refId="4"/>  
   </generalization>  
+  <generalization id="20">    
+    <end type="SOURCE" refId="6"/>    
+    <end type="TARGET" refId="10"/>  
+  </generalization>  
+  <generalization id="21">    
+    <end type="SOURCE" refId="7"/>    
+    <end type="TARGET" refId="5"/>  
+  </generalization>  
+  <generalization id="22">    
+    <end type="SOURCE" refId="3"/>    
+    <end type="TARGET" refId="2"/>  
+  </generalization>  
   <generalization id="23">    
-    <end type="SOURCE" refId="8"/>    
+    <end type="SOURCE" refId="11"/>    
-    <end type="TARGET" refId="1"/>  
+    <end type="TARGET" refId="10"/>  
   </generalization>  
   <classifier-display autosize="true" stereotype="true" package="true" initial-value="false" signature="true" 
     sort-features="false" accessors="true" visibility="true">    

bridge/index.md

@@ -11,7 +11,7 @@ tags: Java
 vary independently.
 
 
-![alt text](./etc/bridge_1.png "Bridge")
+![alt text](./etc/bridge.png "Bridge")
 
 **Applicability:** Use the Bridge pattern when
 

bridge/src/main/java/com/iluwatar/bridge/App.java

@@ -2,13 +2,17 @@ package com.iluwatar.bridge;
 
 /**
  * 
- * In Bridge pattern both abstraction (MagicWeapon) and implementation
+ * In Bridge pattern both abstraction ({@link MagicWeapon}) and implementation
- * (MagicWeaponImp) have their own class hierarchies. The interface of the
+ * ({@link MagicWeaponImpl}) have their own class hierarchies. The interface of the
  * implementations can be changed without affecting the clients.
  * 
  */
 public class App {
 
+	/**
+	 * Program entry point
+	 * @param args command line args
+	 */
 	public static void main(String[] args) {
 		BlindingMagicWeapon blindingMagicWeapon = new BlindingMagicWeapon(
 				new Excalibur());

bridge/src/main/java/com/iluwatar/bridge/BlindingMagicWeapon.java

@@ -1,14 +1,19 @@
 package com.iluwatar.bridge;
 
+/**
+ * 
+ * BlindingMagicWeapon
+ *
+ */
 public class BlindingMagicWeapon extends MagicWeapon {
 
-	public BlindingMagicWeapon(BlindingMagicWeaponImp imp) {
+	public BlindingMagicWeapon(BlindingMagicWeaponImpl imp) {
 		super(imp);
 	}
 
 	@Override
-	public BlindingMagicWeaponImp getImp() {
+	public BlindingMagicWeaponImpl getImp() {
-		return (BlindingMagicWeaponImp) imp;
+		return (BlindingMagicWeaponImpl) imp;
 	}
 
 	@Override

bridge/src/main/java/com/iluwatar/bridge/BlindingMagicWeaponImp.java

@@ -1,7 +0,0 @@
-package com.iluwatar.bridge;
-
-public abstract class BlindingMagicWeaponImp extends MagicWeaponImp {
-
-	public abstract void blindImp();
-
-}

bridge/src/main/java/com/iluwatar/bridge/BlindingMagicWeaponImpl.java

@@ -0,0 +1,12 @@
+package com.iluwatar.bridge;
+
+/**
+ * 
+ * BlindingMagicWeaponImpl
+ *
+ */
+public abstract class BlindingMagicWeaponImpl extends MagicWeaponImpl {
+
+	public abstract void blindImp();
+
+}

bridge/src/main/java/com/iluwatar/bridge/Excalibur.java

@@ -1,6 +1,11 @@
 package com.iluwatar.bridge;
 
-public class Excalibur extends BlindingMagicWeaponImp {
+/**
+ * 
+ * Excalibur
+ *
+ */
+public class Excalibur extends BlindingMagicWeaponImpl {
 
 	@Override
 	public void wieldImp() {

bridge/src/main/java/com/iluwatar/bridge/FlyingMagicWeapon.java

@@ -1,13 +1,18 @@
 package com.iluwatar.bridge;
 
+/**
+ * 
+ * FlyingMagicWeapon
+ *
+ */
 public class FlyingMagicWeapon extends MagicWeapon {
 
-	public FlyingMagicWeapon(FlyingMagicWeaponImp imp) {
+	public FlyingMagicWeapon(FlyingMagicWeaponImpl imp) {
 		super(imp);
 	}
 
-	public FlyingMagicWeaponImp getImp() {
+	public FlyingMagicWeaponImpl getImp() {
-		return (FlyingMagicWeaponImp) imp;
+		return (FlyingMagicWeaponImpl) imp;
 	}
 
 	@Override

bridge/src/main/java/com/iluwatar/bridge/FlyingMagicWeaponImp.java

@@ -1,7 +0,0 @@
-package com.iluwatar.bridge;
-
-public abstract class FlyingMagicWeaponImp extends MagicWeaponImp {
-
-	public abstract void flyImp();
-
-}

bridge/src/main/java/com/iluwatar/bridge/FlyingMagicWeaponImpl.java

@@ -0,0 +1,12 @@
+package com.iluwatar.bridge;
+
+/**
+ * 
+ * FlyingMagicWeaponImpl
+ *
+ */
+public abstract class FlyingMagicWeaponImpl extends MagicWeaponImpl {
+
+	public abstract void flyImp();
+
+}

bridge/src/main/java/com/iluwatar/bridge/MagicWeapon.java

@@ -2,14 +2,14 @@ package com.iluwatar.bridge;
 
 /**
  * 
- * Abstraction interface.
+ * MagicWeapon
  * 
  */
 public abstract class MagicWeapon {
 
-	protected MagicWeaponImp imp;
+	protected MagicWeaponImpl imp;
 
-	public MagicWeapon(MagicWeaponImp imp) {
+	public MagicWeapon(MagicWeaponImpl imp) {
 		this.imp = imp;
 	}
 
@@ -19,7 +19,7 @@ public abstract class MagicWeapon {
 
 	public abstract void unwield();
 
-	public MagicWeaponImp getImp() {
+	public MagicWeaponImpl getImp() {
 		return imp;
 	}
 

bridge/src/main/java/com/iluwatar/bridge/MagicWeaponImpl.java

@@ -2,10 +2,10 @@ package com.iluwatar.bridge;
 
 /**
  * 
- * Implementation interface.
+ * MagicWeaponImpl
  * 
  */
-public abstract class MagicWeaponImp {
+public abstract class MagicWeaponImpl {
 
 	public abstract void wieldImp();
 

bridge/src/main/java/com/iluwatar/bridge/Mjollnir.java

@@ -1,6 +1,11 @@
 package com.iluwatar.bridge;
 
-public class Mjollnir extends FlyingMagicWeaponImp {
+/**
+ * 
+ * Mjollnir
+ *
+ */
+public class Mjollnir extends FlyingMagicWeaponImpl {
 
 	@Override
 	public void wieldImp() {

bridge/src/main/java/com/iluwatar/bridge/SoulEatingMagicWeapon.java

@@ -1,14 +1,19 @@
 package com.iluwatar.bridge;
 
+/**
+ * 
+ * SoulEatingMagicWeapon
+ *
+ */
 public class SoulEatingMagicWeapon extends MagicWeapon {
 
-	public SoulEatingMagicWeapon(SoulEatingMagicWeaponImp imp) {
+	public SoulEatingMagicWeapon(SoulEatingMagicWeaponImpl imp) {
 		super(imp);
 	}
 
 	@Override
-	public SoulEatingMagicWeaponImp getImp() {
+	public SoulEatingMagicWeaponImpl getImp() {
-		return (SoulEatingMagicWeaponImp) imp;
+		return (SoulEatingMagicWeaponImpl) imp;
 	}
 
 	@Override

bridge/src/main/java/com/iluwatar/bridge/SoulEatingMagicWeaponImp.java

@@ -1,7 +0,0 @@
-package com.iluwatar.bridge;
-
-public abstract class SoulEatingMagicWeaponImp extends MagicWeaponImp {
-
-	public abstract void eatSoulImp();
-
-}

bridge/src/main/java/com/iluwatar/bridge/SoulEatingMagicWeaponImpl.java

@@ -0,0 +1,12 @@
+package com.iluwatar.bridge;
+
+/**
+ * 
+ * SoulEatingMagicWeaponImpl
+ *
+ */
+public abstract class SoulEatingMagicWeaponImpl extends MagicWeaponImpl {
+
+	public abstract void eatSoulImp();
+
+}

bridge/src/main/java/com/iluwatar/bridge/Stormbringer.java

@@ -1,6 +1,11 @@
 package com.iluwatar.bridge;
 
-public class Stormbringer extends SoulEatingMagicWeaponImp {
+/**
+ * 
+ * Stormbringer
+ *
+ */
+public class Stormbringer extends SoulEatingMagicWeaponImpl {
 
 	@Override
 	public void wieldImp() {

bridge/src/test/java/com/iluwatar/bridge/AppTest.java

@@ -4,6 +4,11 @@ import org.junit.Test;
 
 import com.iluwatar.bridge.App;
 
+/**
+ * 
+ * Application test
+ *
+ */
 public class AppTest {
 
 	@Test

builder/src/main/java/com/iluwatar/builder/App.java

@@ -6,17 +6,21 @@ import com.iluwatar. builder.Hero.HeroBuilder;
  * 
  * This is the Builder pattern variation as described by Joshua Bloch in
  * Effective Java 2nd Edition.
- * 
+ * <p>
- * We want to build Hero objects, but its construction is complex because of the
+ * We want to build {@link Hero} objects, but its construction is complex because of the
- * many parameters needed. To aid the user we introduce HeroBuilder class.
+ * many parameters needed. To aid the user we introduce {@link HeroBuilder} class.
- * HeroBuilder takes the minimum parameters to build Hero object in its
+ * {@link HeroBuilder} takes the minimum parameters to build {@link Hero} object in its
- * constructor. After that additional configuration for the Hero object can be
+ * constructor. After that additional configuration for the {@link Hero} object can be
- * done using the fluent HeroBuilder interface. When configuration is ready the
+ * done using the fluent {@link HeroBuilder} interface. When configuration is ready the
- * build method is called to receive the final Hero object.
+ * build method is called to receive the final {@link Hero} object.
  * 
  */
 public class App {
 
+	/**
+	 * Program entry point
+	 * @param args command line args
+	 */
 	public static void main(String[] args) {
 
 		Hero mage = new HeroBuilder(Profession.MAGE, "Riobard")

builder/src/main/java/com/iluwatar/builder/Armor.java

@@ -1,5 +1,10 @@
 package com.iluwatar.builder;
 
+/**
+ * 
+ * Armor enumeration
+ *
+ */
 public enum Armor {
 
 	CLOTHES("clothes"), LEATHER("leather"), CHAIN_MAIL("chain mail"), PLATE_MAIL("plate mail");

builder/src/main/java/com/iluwatar/builder/HairColor.java

@@ -1,5 +1,10 @@
 package com.iluwatar.builder;
 
+/**
+ * 
+ * HairColor enumeration
+ *
+ */
 public enum HairColor {
 
 	WHITE, BLOND, RED, BROWN, BLACK;

builder/src/main/java/com/iluwatar/builder/HairType.java

@@ -1,5 +1,10 @@
 package com.iluwatar.builder;
 
+/**
+ * 
+ * HairType enumeration
+ *
+ */
 public enum HairType {
 
 	BALD("bald"), SHORT("short"), CURLY("curly"), LONG_STRAIGHT("long straight"), LONG_CURLY("long curly");

builder/src/main/java/com/iluwatar/builder/Hero.java

@@ -2,7 +2,7 @@ package com.iluwatar.builder;
 
 /**
  * 
- * The class with many parameters.
+ * Hero, the class with many parameters.
  * 
  */
 public class Hero {

builder/src/main/java/com/iluwatar/builder/Profession.java

@@ -1,5 +1,10 @@
 package com.iluwatar.builder;
 
+/**
+ * 
+ * Profession enumeration
+ *
+ */
 public enum Profession {
 
 	WARRIOR, THIEF, MAGE, PRIEST;

builder/src/main/java/com/iluwatar/builder/Weapon.java

@@ -1,5 +1,10 @@
 package com.iluwatar.builder;
 
+/**
+ * 
+ * Weapon enumeration
+ *
+ */
 public enum Weapon {
 
 	DAGGER, SWORD, AXE, WARHAMMER, BOW;

builder/src/test/java/com/iluwatar/builder/AppTest.java

@@ -4,6 +4,11 @@ import org.junit.Test;
 
 import com.iluwatar. builder.App;
 
+/**
+ * 
+ * Application test
+ *
+ */
 public class AppTest {
 
 	@Test

business-delegate/src/main/java/com/iluwatar/business/delegate/App.java

@@ -2,21 +2,25 @@ package com.iluwatar.business.delegate;
 
 /**
  * 
- * The Business Delegate pattern adds an abstraction layer between presentation and business tiers.
+ * The Business Delegate pattern adds an abstraction layer between the presentation and business tiers.
  * By using the pattern we gain loose coupling between the tiers. The Business Delegate encapsulates
  * knowledge about how to locate, connect to, and interact with the business objects that make up
  * the application.
- * 
+ * <p>
  * Some of the services the Business Delegate uses are instantiated directly, and some can be retrieved
  * through service lookups. The Business Delegate itself may contain business logic too potentially tying
  * together multiple service calls, exception handling, retrying etc.
- * 
+ * <p>
- * In this example the client (Client) utilizes a business delegate (BusinessDelegate) to execute a task.
+ * In this example the client ({@link Client}) utilizes a business delegate ({@link BusinessDelegate}) to execute a task.
  * The Business Delegate then selects the appropriate service and makes the service call.
  *
  */
 public class App {
 	
+	/**
+	 * Program entry point
+	 * @param args command line args
+	 */
 	public static void main(String[] args) {
 		
 		BusinessDelegate businessDelegate = new BusinessDelegate();

business-delegate/src/main/java/com/iluwatar/business/delegate/BusinessDelegate.java

@@ -2,7 +2,7 @@ package com.iluwatar.business.delegate;
 
 /**
  * 
- * BusinessDelegate separates presentation and business tiers
+ * BusinessDelegate separates the presentation and business tiers
  *
  */
 public class BusinessDelegate {

business-delegate/src/test/java/com/iluwatar/business/delegate/AppTest.java

@@ -4,6 +4,11 @@ import org.junit.Test;
 
 import com.iluwatar.business.delegate.App;
 
+/**
+ * 
+ * Application test
+ *
+ */
 public class AppTest {
 	
 	@Test

callback/src/main/java/com/iluwatar/callback/App.java

@@ -1,8 +1,10 @@
 package com.iluwatar.callback;
 
 /**
- * Callback pattern is more native for functional languages where function is treated as first-class citizen.
+ * 
- * Prior to Java8 can be simulated using simple (alike command) interfaces.
+ * Callback pattern is more native for functional languages where functions are treated as first-class citizens.
+ * Prior to Java 8 callbacks can be simulated using simple (alike command) interfaces.
+ * 
  */
 public class App {
 

callback/src/main/java/com/iluwatar/callback/Callback.java

@@ -1,7 +1,9 @@
 package com.iluwatar.callback;
 
 /**
+ * 
  * Callback interface
+ * 
  */
 public interface Callback {
 

callback/src/main/java/com/iluwatar/callback/SimpleTask.java

@@ -1,7 +1,9 @@
 package com.iluwatar.callback;
 
 /**
+ * 
  * Implementation of task that need to be executed
+ * 
  */
 public class SimpleTask extends Task {
 

callback/src/main/java/com/iluwatar/callback/Task.java

@@ -1,7 +1,9 @@
 package com.iluwatar.callback;
 
 /**
+ * 
  * Template-method class for callback hook execution
+ * 
  */
 public abstract class Task {
 

callback/src/test/java/com/iluwatar/callback/AppTest.java

@@ -4,6 +4,11 @@ import org.junit.Test;
 
 import com.iluwatar.callback.App;
 
+/**
+ * 
+ * Application test
+ *
+ */
 public class AppTest {
 
 	@Test

chain/src/main/java/com/iluwatar/chain/App.java

@@ -2,14 +2,18 @@ package com.iluwatar.chain;
 
 /**
  * 
- * Chain of Responsibility organizes request handlers (RequestHandler) into a
+ * Chain of Responsibility organizes request handlers ({@link RequestHandler}) into a
  * chain where each handler has a chance to act on the request on its turn. In
- * this example the king (OrcKing) makes requests and the military orcs
+ * this example the king ({@link OrcKing}) makes requests and the military orcs
- * (OrcCommander, OrcOfficer, OrcSoldier) form the handler chain.
+ * ({@link OrcCommander}, {@link OrcOfficer}, {@link OrcSoldier}) form the handler chain.
  * 
  */
 public class App {
 
+	/**
+	 * Program entry point
+	 * @param args command line args
+	 */
 	public static void main(String[] args) {
 
 		OrcKing king = new OrcKing();

chain/src/main/java/com/iluwatar/chain/OrcCommander.java

@@ -1,5 +1,10 @@
 package com.iluwatar.chain;
 
+/**
+ * 
+ * OrcCommander
+ *
+ */
 public class OrcCommander extends RequestHandler {
 
 	public OrcCommander(RequestHandler handler) {

chain/src/main/java/com/iluwatar/chain/OrcKing.java

@@ -2,7 +2,7 @@ package com.iluwatar.chain;
 
 /**
  * 
- * Makes requests that are handled by the chain.
+ * OrcKing makes requests that are handled by the chain.
  * 
  */
 public class OrcKing {

chain/src/main/java/com/iluwatar/chain/OrcOfficer.java

@@ -1,5 +1,10 @@
 package com.iluwatar.chain;
 
+/**
+ * 
+ * OrcOfficer
+ *
+ */
 public class OrcOfficer extends RequestHandler {
 
 	public OrcOfficer(RequestHandler handler) {

chain/src/main/java/com/iluwatar/chain/OrcSoldier.java

@@ -1,5 +1,10 @@
 package com.iluwatar.chain;
 
+/**
+ * 
+ * OrcSoldier
+ *
+ */
 public class OrcSoldier extends RequestHandler {
 
 	public OrcSoldier(RequestHandler handler) {

chain/src/main/java/com/iluwatar/chain/Request.java

@@ -1,5 +1,10 @@
 package com.iluwatar.chain;
 
+/**
+ * 
+ * Request
+ *
+ */
 public class Request {
 
 	private String requestDescription;

chain/src/main/java/com/iluwatar/chain/RequestHandler.java

@@ -1,5 +1,10 @@
 package com.iluwatar.chain;
 
+/**
+ * 
+ * RequestHandler
+ *
+ */
 public abstract class RequestHandler {
 
 	private RequestHandler next;

chain/src/main/java/com/iluwatar/chain/RequestType.java

@@ -1,5 +1,10 @@
 package com.iluwatar.chain;
 
+/**
+ * 
+ * RequestType enumeration
+ *
+ */
 public enum RequestType {
 
 	DEFEND_CASTLE, TORTURE_PRISONER, COLLECT_TAX

chain/src/test/java/com/iluwatar/chain/AppTest.java

@@ -4,6 +4,11 @@ import org.junit.Test;
 
 import com.iluwatar.chain.App;
 
+/**
+ * 
+ * Application test
+ *
+ */
 public class AppTest {
 
 	@Test

command/src/main/java/com/iluwatar/command/App.java

@@ -3,15 +3,15 @@ package com.iluwatar.command;
 /**
  * 
  * In Command pattern actions are objects that can be executed and undone. 
- *
+ * <p>
  * Four terms always associated with the command pattern are command, receiver, invoker and client. A command 
- * object (spell) knows about receiver (target) and invokes a method of the receiver. Values for parameters of 
+ * object (spell) knows about the receiver (target) and invokes a method of the receiver. Values for parameters of 
  * the receiver method are stored in the command. The receiver then does the work. An invoker object (wizard) 
  * knows how to execute a command, and optionally does bookkeeping about the command execution. The invoker 
  * does not know anything about a concrete command, it knows only about command interface. Both an invoker object 
  * and several command objects are held by a client object (app). The client decides which commands to execute at 
  * which points. To execute a command, it passes the command object to the invoker object.
- * 
+ * <p>
  * In other words, in this example the wizard casts spells on the goblin. The wizard keeps track of the previous
  * spells cast, so it is easy to undo them. In addition, the wizard keeps track of the spells undone, so they
  * can be redone.
@@ -20,6 +20,10 @@ package com.iluwatar.command;
  */
 public class App {
 
+	/**
+	 * Program entry point
+	 * @param args command line args
+	 */
 	public static void main(String[] args) {
 		Wizard wizard = new Wizard();
 		Goblin goblin = new Goblin();

command/src/test/java/com/iluwatar/command/AppTest.java

@@ -4,6 +4,11 @@ import org.junit.Test;
 
 import com.iluwatar.command.App;
 
+/**
+ * 
+ * Application test
+ *
+ */
 public class AppTest {
 
 	@Test

composite/src/main/java/com/iluwatar/composite/App.java

@@ -3,12 +3,16 @@ package com.iluwatar.composite;
 /**
  * 
  * With Composite we can treat tree hierarchies of objects with uniform
- * interface (LetterComposite). In this example we have sentences composed of
+ * interface ({@link LetterComposite}). In this example we have sentences composed of
  * words composed of letters.
  * 
  */
 public class App {
 
+	/**
+	 * Program entry point
+	 * @param args command line args
+	 */
 	public static void main(String[] args) {
 		System.out.println("Message from the orcs: ");
 

composite/src/main/java/com/iluwatar/composite/Letter.java

@@ -1,5 +1,10 @@
 package com.iluwatar.composite;
 
+/**
+ * 
+ * Letter
+ *
+ */
 public class Letter extends LetterComposite {
 
 	private char c;

composite/src/main/java/com/iluwatar/composite/Messenger.java

@@ -4,6 +4,11 @@ import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.List;
 
+/**
+ * 
+ * Messenger
+ *
+ */
 public class Messenger {
 
 	LetterComposite messageFromOrcs() {

composite/src/main/java/com/iluwatar/composite/Sentence.java

@@ -2,6 +2,11 @@ package com.iluwatar.composite;
 
 import java.util.List;
 
+/**
+ * 
+ * Sentence
+ *
+ */
 public class Sentence extends LetterComposite {
 
 	public Sentence(List<Word> words) {

composite/src/main/java/com/iluwatar/composite/Word.java

@@ -2,6 +2,11 @@ package com.iluwatar.composite;
 
 import java.util.List;
 
+/**
+ * 
+ * Word
+ *
+ */
 public class Word extends LetterComposite {
 
 	public Word(List<Letter> letters) {

composite/src/test/java/com/iluwatar/composite/AppTest.java

@@ -4,6 +4,11 @@ import org.junit.Test;
 
 import com.iluwatar.composite.App;
 
+/**
+ * 
+ * Application test
+ *
+ */
 public class AppTest {
 
 	@Test

dao/src/main/java/com/iluwatar/dao/App.java

@@ -7,9 +7,14 @@ import java.util.List;
  * 
  * With the DAO pattern, we can use various method calls to retrieve/add/delete/update data without directly
  * interacting with the data. The below example demonstrates basic operations(CRUD): select, add, update, and delete.
+ * 
  */
 public class App {
 
+	/**
+	 * Program entry point
+	 * @param args command line args
+	 */
 	public static void main(String[] args) {
 
 		CustomerDaoImpl customerDao = new CustomerDaoImpl(generateSampleCustomers());
@@ -33,6 +38,10 @@ public class App {
 		System.out.println("customerDao.getAllCustomers(): " + customerDao.getAllCustomers());
 	}
 
+	/**
+	 * Generate customers
+	 * @return list of customers
+	 */
 	public static List<Customer> generateSampleCustomers() {
 		Customer customer1 = new Customer(1, "Adam", "Adamson");
 		Customer customer2 = new Customer(2, "Bob", "Bobson");

dao/src/main/java/com/iluwatar/dao/Customer.java

@@ -1,6 +1,12 @@
 package com.iluwatar.dao;
 
+/**
+ * 
+ * Customer
+ *
+ */
 public class Customer {
+	
     private int id;
     private String firstName;
     private String lastName;

dao/src/main/java/com/iluwatar/dao/CustomerDao.java

@@ -2,7 +2,13 @@ package com.iluwatar.dao;
 
 import java.util.List;
 
+/**
+ * 
+ * CustomerDao
+ *
+ */
 public interface CustomerDao {
+	
     public List<Customer> getAllCustomers();
     public Customer getCusterById(int id);
     public void addCustomer(Customer customer);

dao/src/main/java/com/iluwatar/dao/CustomerDaoImpl.java

@@ -3,11 +3,13 @@ package com.iluwatar.dao;
 import java.util.List;
 
 /**
+ * 
  * The data access object (DAO) is an object that provides an abstract interface to some type of database or other persistence mechanism.
  * By mapping application calls to the persistence layer, DAO provide some specific data operations without exposing details of the database.
  * This isolation supports the Single responsibility principle. It separates what data accesses the application needs, in terms of
  * domain-specific objects and data types (the public interface of the DAO), from how these needs can be satisfied with a specific DBMS,
  * database schema, etc.
+ * 
  */
 public class CustomerDaoImpl implements CustomerDao {
 

dao/src/test/java/com/iluwatar/dao/AppTest.java

@@ -4,6 +4,11 @@ import org.junit.Test;
 
 import com.iluwatar.dao.App;
 
+/**
+ * 
+ * Application test
+ *
+ */
 public class AppTest {
 
 	@Test

decorator/src/main/java/com/iluwatar/decorator/App.java

@@ -2,16 +2,20 @@ package com.iluwatar.decorator;
 
 /**
  * 
- * Decorator pattern is more flexible alternative to subclassing. The decorator
+ * Decorator pattern is a more flexible alternative to subclassing. The decorator
  * class implements the same interface as the target and uses composition to
  * "decorate" calls to the target.
- * 
+ * <p>
  * Using decorator pattern it is possible to change class behavior during
  * runtime, as the example shows.
  * 
  */
 public class App {
 
+	/**
+	 * Program entry point
+	 * @param args command line args
+	 */
 	public static void main(String[] args) {
 
 		// simple troll

decorator/src/main/java/com/iluwatar/decorator/SmartTroll.java

@@ -1,10 +1,10 @@
 package com.iluwatar.decorator;
 
 /**
- * SmartTroll is a decorator for Hostile objects.
+ * SmartTroll is a decorator for {@link Hostile} objects.
- * The calls to the Hostile interface are intercepted
+ * The calls to the {@link Hostile} interface are intercepted
  * and decorated. Finally the calls are delegated
- * to the decorated Hostile object.
+ * to the decorated {@link Hostile} object.
  *
  */
 public class SmartTroll implements Hostile {

decorator/src/main/java/com/iluwatar/decorator/Troll.java

@@ -2,7 +2,7 @@ package com.iluwatar.decorator;
 
 /**
  * 
- * Troll implements Hostile interface directly.
+ * Troll implements {@link Hostile} interface directly.
  *
  */
 public class Troll implements Hostile {

decorator/src/test/java/com/iluwatar/decorator/AppTest.java

@@ -4,6 +4,11 @@ import org.junit.Test;
 
 import com.iluwatar.decorator.App;
 
+/**
+ * 
+ * Application test
+ *
+ */
 public class AppTest {
 
 	@Test

dependency-injection/src/main/java/com/iluwatar/dependency/injection/App.java

@@ -9,23 +9,27 @@ import com.google.inject.Injector;
  * implements so called inversion of control principle. Inversion of control has two specific rules:
  *  - High-level modules should not depend on low-level modules. Both should depend on abstractions.
  *  - Abstractions should not depend on details. Details should depend on abstractions.
- *  
+ *  <p>
- *  In this example we show you three different wizards. The first one (SimpleWizard) is a naive 
+ *  In this example we show you three different wizards. The first one ({@link SimpleWizard}) is a naive 
  *  implementation violating the inversion of control principle. It depends directly on a concrete
  *  implementation which cannot be changed.
- *  
+ *  <p>
- *  The second wizard (AdvancedWizard) is more flexible. It does not depend on any concrete implementation 
+ *  The second wizard ({@link AdvancedWizard}) is more flexible. It does not depend on any concrete implementation 
- *  but abstraction. It utilizes Dependency Injection pattern allowing its Tobacco dependency to be
+ *  but abstraction. It utilizes Dependency Injection pattern allowing its {@link Tobacco} dependency to be
  *  injected through its constructor. This way, handling the dependency is no longer the wizard's
  *  responsibility. It is resolved outside the wizard class.
- *  
+ *  <p>
  *  The third example takes the pattern a step further. It uses Guice framework for Dependency Injection.
- *  TobaccoModule binds a concrete implementation to abstraction. Injector is then used to create
+ *  {@link TobaccoModule} binds a concrete implementation to abstraction. Injector is then used to create
- *  GuiceWizard object with correct dependencies.
+ *  {@link GuiceWizard} object with correct dependencies.
  *
  */
 public class App {
 	
+	/**
+	 * Program entry point
+	 * @param args command line args
+	 */
     public static void main( String[] args ) {
     	SimpleWizard simpleWizard = new SimpleWizard();
     	simpleWizard.smoke();

dependency-injection/src/main/java/com/iluwatar/dependency/injection/OldTobyTobacco.java

@@ -2,7 +2,7 @@ package com.iluwatar.dependency.injection;
 
 /**
  * 
- * OldTobyTobacco concrete Tobacco implementation
+ * OldTobyTobacco concrete {@link Tobacco} implementation
  *
  */
 public class OldTobyTobacco extends Tobacco {

dependency-injection/src/main/java/com/iluwatar/dependency/injection/RivendellTobacco.java

@@ -2,7 +2,7 @@ package com.iluwatar.dependency.injection;
 
 /**
  * 
- * RivendellTobacco concrete Tobacco implementation
+ * RivendellTobacco concrete {@link Tobacco} implementation
  *
  */
 public class RivendellTobacco extends Tobacco {

dependency-injection/src/main/java/com/iluwatar/dependency/injection/SecondBreakfastTobacco.java

@@ -2,7 +2,7 @@ package com.iluwatar.dependency.injection;
 
 /**
  * 
- * SecondBreakfastTobacco concrete Tobacco implementation
+ * SecondBreakfastTobacco concrete {@link Tobacco} implementation
  *
  */
 public class SecondBreakfastTobacco extends Tobacco {

dependency-injection/src/main/java/com/iluwatar/dependency/injection/TobaccoModule.java

@@ -4,7 +4,7 @@ import com.google.inject.AbstractModule;
 
 /**
  * 
- * Guice module for binding certain concrete Tobacco implementation.
+ * Guice module for binding certain concrete {@link Tobacco} implementation.
  *
  */
 public class TobaccoModule extends AbstractModule {

dependency-injection/src/test/java/com/iluwatar/dependency/injection/AppTest.java

@@ -4,6 +4,11 @@ import org.junit.Test;
 
 import com.iluwatar.dependency.injection.App;
 
+/**
+ * 
+ * Application test
+ *
+ */
 public class AppTest {
 
 	@Test

double-checked-locking/src/main/java/com/iluwatar/doublechecked/locking/App.java

@@ -5,13 +5,18 @@ import java.util.concurrent.Executors;
 
 /**
  * 
- * In Inventory we store the items with a given size. However, we do not store
+ * In {@link Inventory} we store the items with a given size. However, we do not store
  * more items than the inventory size. To address concurrent access problems we
  * use double checked locking to add item to inventory. In this method, the
  * thread which gets the lock first adds the item.
+ * 
  */
 public class App {
 
+	/**
+	 * Program entry point
+	 * @param args command line args
+	 */
 	public static void main(String[] args) {
 		final Inventory inventory = new Inventory(1000);
 		ExecutorService executorService = Executors.newFixedThreadPool(3);

double-checked-locking/src/main/java/com/iluwatar/doublechecked/locking/Inventory.java

@@ -5,6 +5,11 @@ import java.util.List;
 import java.util.concurrent.locks.Lock;
 import java.util.concurrent.locks.ReentrantLock;
 
+/**
+ * 
+ * Inventory
+ *
+ */
 public class Inventory {
 
 	private int inventorySize;

double-checked-locking/src/main/java/com/iluwatar/doublechecked/locking/Item.java

@@ -1,6 +1,12 @@
 package com.iluwatar.doublechecked.locking;
 
+/**
+ * 
+ * Item
+ *
+ */
 public class Item {
-	String name;
+	
-	int level;
+	private String name;
+	private int level;
 }

double-checked-locking/src/test/java/com/iluwatar/doublechecked/locking/AppTest.java

@@ -4,6 +4,11 @@ import org.junit.Test;
 
 import com.iluwatar.doublechecked.locking.App;
 
+/**
+ * 
+ * Application test
+ *
+ */
 public class AppTest {
 
 	@Test

double-dispatch/src/main/java/com/iluwatar/doubledispatch/App.java

@@ -8,23 +8,27 @@ import java.util.List;
  * When a message with a parameter is sent to an object, the resultant behaviour is defined by the 
  * implementation of that method in the receiver. Sometimes the behaviour must also be determined 
  * by the type of the parameter.
- * 
+ * <p>
  * One way to implement this would be to create multiple instanceof-checks for the methods parameter.
  * However, this creates a maintenance issue. When new types are added we would also need to change
  * the method's implementation and add a new instanceof-check. This violates the single responsibility
  * principle - a class should have only one reason to change.
- * 
+ * <p>
  * Instead of the instanceof-checks a better way is to make another virtual call on the parameter
  * object. This way new functionality can be easily added without the need to modify existing
  * implementation (open-closed principle).
- * 
+ * <p>
- * In this example we have hierarchy of objects (GameObject) that can collide to each other. Each
+ * In this example we have hierarchy of objects ({@link GameObject}) that can collide to each other. Each
  * object has its own coordinates which are checked against the other objects' coordinates. If
  * there is an overlap, then the objects collide utilizing the Double Dispatch pattern.
  *
  */
 public class App {
 	
+	/**
+	 * Program entry point
+	 * @param args command line args
+	 */
     public static void main( String[] args ) {
     	// initialize game objects and print their status
     	List<GameObject> objects = new ArrayList<>();

double-dispatch/src/test/java/com/iluwatar/doubledispatch/AppTest.java

@@ -4,6 +4,11 @@ import org.junit.Test;
 
 import com.iluwatar.doubledispatch.App;
 
+/**
+ * 
+ * Application test
+ *
+ */
 public class AppTest {
 	
 	@Test

event-aggregator/src/main/java/com/iluwatar/event/aggregator/App.java

@@ -7,14 +7,18 @@ import java.util.List;
  * 
  * The Event Aggregator pattern channels events from multiple objects 
  * into a single object to simplify registration for clients.
- * 
+ * <p>
- * In the example LordBaelish, LordVarys and Scout deliver events to
+ * In the example {@link LordBaelish}, {@link LordVarys} and {@link Scout} deliver events to
- * KingsHand. KingsHand, the event aggregator, then delivers the events
+ * {@link KingsHand}. {@link KingsHand}, the event aggregator, then delivers the events
- * to KingJoffrey.
+ * to {@link KingJoffrey}.
  *
  */
 public class App {
 
+	/**
+	 * Program entry point
+	 * @param args command line args
+	 */
 	public static void main(String[] args) {
 		
 		KingJoffrey kingJoffrey = new KingJoffrey();

event-aggregator/src/main/java/com/iluwatar/event/aggregator/KingJoffrey.java

@@ -2,7 +2,7 @@ package com.iluwatar.event.aggregator;
 
 /**
  * 
- * KingJoffrey observes events from KingsHand.
+ * KingJoffrey observes events from {@link KingsHand}.
  *
  */
 public class KingJoffrey implements EventObserver {