iluwatar#107 Improve JavaDoc for Visitor example

iluwatar · iluwatar · commit d220a0753a85 · 2015-08-21T23:27:25.000+03:00
diff --git a/visitor/src/main/java/com/iluwatar/visitor/App.java b/visitor/src/main/java/com/iluwatar/visitor/App.java
@@ -1,27 +1,31 @@
-package com.iluwatar.visitor;
-
-/**
- * 
- * Visitor pattern defines mechanism to apply operations on nodes
- * in hierarchy. New operations can be added without altering the node
- * interface.
- * 
- * In this example there is a unit hierarchy beginning from Commander.
- * This hierarchy is traversed by visitors. SoldierVisitor applies
- * its operation on Soldiers, SergeantVisitor on Sergeants and so
- * on.
- * 
- */
-public class App {
-
-	public static void main(String[] args) {
-
-		Commander commander = new Commander(new Sergeant(new Soldier(),
-				new Soldier(), new Soldier()), new Sergeant(new Soldier(),
-				new Soldier(), new Soldier()));
-		commander.accept(new SoldierVisitor());
-		commander.accept(new SergeantVisitor());
-		commander.accept(new CommanderVisitor());
-
-	}
-}
+package com.iluwatar.visitor;
+
+/**
+ * 
+ * Visitor pattern defines mechanism to apply operations on nodes
+ * in hierarchy. New operations can be added without altering the node
+ * interface.
+ * <p>
+ * In this example there is a unit hierarchy beginning from {@link Commander}.
+ * This hierarchy is traversed by visitors. {@link SoldierVisitor} applies
+ * its operation on {@link Soldier}s, {@link SergeantVisitor} on {@link Sergeant}s and so
+ * on.
+ * 
+ */
+public class App {
+
+	/**
+	 * Program entry point
+	 * @param args command line args
+	 */
+	public static void main(String[] args) {
+
+		Commander commander = new Commander(new Sergeant(new Soldier(),
+				new Soldier(), new Soldier()), new Sergeant(new Soldier(),
+				new Soldier(), new Soldier()));
+		commander.accept(new SoldierVisitor());
+		commander.accept(new SergeantVisitor());
+		commander.accept(new CommanderVisitor());
+
+	}
+}
diff --git a/visitor/src/test/java/com/iluwatar/visitor/AppTest.java b/visitor/src/test/java/com/iluwatar/visitor/AppTest.java
@@ -1,14 +1,19 @@
-package com.iluwatar.visitor;
-
-import org.junit.Test;
-
-import com.iluwatar.visitor.App;
-
-public class AppTest {
-
-	@Test
-	public void test() {
-		String[] args = {};
-		App.main(args);
-	}
-}
+package com.iluwatar.visitor;
+
+import org.junit.Test;
+
+import com.iluwatar.visitor.App;
+
+/**
+ * 
+ * Application test
+ *
+ */
+public class AppTest {
+
+	@Test
+	public void test() {
+		String[] args = {};
+		App.main(args);
+	}
+}
