#107 JavaDoc for State pattern

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

@@ -1,24 +1,24 @@
-package com.iluwatar.state;
-
-/**
- * 
- * In State pattern the container object (Mammoth) has an internal state object (State) that
- * defines the current behavior. The state object can be changed to alter the
- * behavior.
- * 
- * In this example the mammoth changes its behavior as time passes by.
- * 
- */
-public class App {
-
-	public static void main(String[] args) {
-
-		Mammoth mammoth = new Mammoth();
-		mammoth.observe();
-		mammoth.timePasses();
-		mammoth.observe();
-		mammoth.timePasses();
-		mammoth.observe();
-
-	}
-}
+package com.iluwatar.state;
+
+/**
+ * 
+ * In State pattern the container object ({@link Mammoth}) has an internal state object ({@link State}) that
+ * defines the current behavior. The state object can be changed to alter the
+ * behavior.
+ * <p>
+ * In this example the {@link Mammoth} changes its behavior as time passes by.
+ * 
+ */
+public class App {
+
+	public static void main(String[] args) {
+
+		Mammoth mammoth = new Mammoth();
+		mammoth.observe();
+		mammoth.timePasses();
+		mammoth.observe();
+		mammoth.timePasses();
+		mammoth.observe();
+
+	}
+}

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

@@ -1,14 +1,19 @@
-package com.iluwatar.state;
-
-import org.junit.Test;
-
-import com.iluwatar.state.App;
-
-public class AppTest {
-
-	@Test
-	public void test() {
-		String[] args = {};
-		App.main(args);
-	}
-}
+package com.iluwatar.state;
+
+import org.junit.Test;
+
+import com.iluwatar.state.App;
+
+/**
+ * 
+ * Application test
+ *
+ */
+public class AppTest {
+
+	@Test
+	public void test() {
+		String[] args = {};
+		App.main(args);
+	}
+}