From 1ec86b732a25e7044babe79bb21ed09280ce1b96 Mon Sep 17 00:00:00 2001
From: Ilkka Seppala <iluwatar@gmail.com>
Date: Tue, 18 Aug 2015 22:44:58 +0300
Subject: [PATCH] #107 Factory Method example JavaDoc

---
 .../main/java/com/iluwatar/factory/method/App.java    | 11 ++++++++---
 .../java/com/iluwatar/factory/method/ElfWeapon.java   |  5 +++++
 .../java/com/iluwatar/factory/method/OrcWeapon.java   |  5 +++++
 .../main/java/com/iluwatar/factory/method/Weapon.java |  5 +++++
 .../java/com/iluwatar/factory/method/WeaponType.java  |  5 +++++
 .../java/com/iluwatar/factory/method/AppTest.java     |  5 +++++
 6 files changed, 33 insertions(+), 3 deletions(-)

diff --git a/factory-method/src/main/java/com/iluwatar/factory/method/App.java b/factory-method/src/main/java/com/iluwatar/factory/method/App.java
index 41b234791..69bda3489 100644
--- a/factory-method/src/main/java/com/iluwatar/factory/method/App.java
+++ b/factory-method/src/main/java/com/iluwatar/factory/method/App.java
@@ -2,13 +2,18 @@ package com.iluwatar.factory.method;
 
 /**
  * 
- * In Factory Method we have an interface (Blacksmith) with a method for
- * creating objects (manufactureWeapon). The concrete subclasses (OrcBlacksmith,
- * ElfBlacksmith) then override the method to produce objects of their liking.
+ * In Factory Method we have an interface ({@link Blacksmith}) with a method for
+ * creating objects ({@link Blacksmith#manufactureWeapon}). The concrete subclasses 
+ * ({@link OrcBlacksmith}, {@link ElfBlacksmith}) then override the method to produce 
+ * objects of their liking.
  * 
  */
 public class App {
 
+	/**
+	 * Program entry point
+	 * @param args command line args
+	 */
 	public static void main(String[] args) {
 		Blacksmith blacksmith;
 		Weapon weapon;
diff --git a/factory-method/src/main/java/com/iluwatar/factory/method/ElfWeapon.java b/factory-method/src/main/java/com/iluwatar/factory/method/ElfWeapon.java
index a425d3ce7..75bb8a9e0 100644
--- a/factory-method/src/main/java/com/iluwatar/factory/method/ElfWeapon.java
+++ b/factory-method/src/main/java/com/iluwatar/factory/method/ElfWeapon.java
@@ -1,5 +1,10 @@
 package com.iluwatar.factory.method;
 
+/**
+ * 
+ * ElfWeapon
+ *
+ */
 public class ElfWeapon implements Weapon {
 
 	private WeaponType weaponType;
diff --git a/factory-method/src/main/java/com/iluwatar/factory/method/OrcWeapon.java b/factory-method/src/main/java/com/iluwatar/factory/method/OrcWeapon.java
index ab9b83991..85500799e 100644
--- a/factory-method/src/main/java/com/iluwatar/factory/method/OrcWeapon.java
+++ b/factory-method/src/main/java/com/iluwatar/factory/method/OrcWeapon.java
@@ -1,5 +1,10 @@
 package com.iluwatar.factory.method;
 
+/**
+ * 
+ * OrcWeapon
+ *
+ */
 public class OrcWeapon implements Weapon {
 
 	private WeaponType weaponType;
diff --git a/factory-method/src/main/java/com/iluwatar/factory/method/Weapon.java b/factory-method/src/main/java/com/iluwatar/factory/method/Weapon.java
index 80e7c911f..a5ae99254 100644
--- a/factory-method/src/main/java/com/iluwatar/factory/method/Weapon.java
+++ b/factory-method/src/main/java/com/iluwatar/factory/method/Weapon.java
@@ -1,5 +1,10 @@
 package com.iluwatar.factory.method;
 
+/**
+ * 
+ * Weapon interface
+ *
+ */
 public interface Weapon {
 
 }
diff --git a/factory-method/src/main/java/com/iluwatar/factory/method/WeaponType.java b/factory-method/src/main/java/com/iluwatar/factory/method/WeaponType.java
index 9ef82fff6..1c0341670 100644
--- a/factory-method/src/main/java/com/iluwatar/factory/method/WeaponType.java
+++ b/factory-method/src/main/java/com/iluwatar/factory/method/WeaponType.java
@@ -1,5 +1,10 @@
 package com.iluwatar.factory.method;
 
+/**
+ * 
+ * WeaponType enumeration
+ *
+ */
 public enum WeaponType {
 
 	SHORT_SWORD("short sword"), SPEAR("spear"), AXE("axe"), UNDEFINED("");
diff --git a/factory-method/src/test/java/com/iluwatar/factory/method/AppTest.java b/factory-method/src/test/java/com/iluwatar/factory/method/AppTest.java
index 9fa0cc5eb..c6db18b3e 100644
--- a/factory-method/src/test/java/com/iluwatar/factory/method/AppTest.java
+++ b/factory-method/src/test/java/com/iluwatar/factory/method/AppTest.java
@@ -4,6 +4,11 @@ import org.junit.Test;
 
 import com.iluwatar.factory.method.App;
 
+/**
+ * 
+ * Application test
+ *
+ */
 public class AppTest {
 
 	@Test