From 6e49fc01ab7c7d1f94e0073787c9c5ef3ae632b0 Mon Sep 17 00:00:00 2001
From: Ilkka Seppala <iluwatar@gmail.com>
Date: Sat, 24 Jan 2015 23:43:35 +0200
Subject: [PATCH] Improved comments on visitor pattern example.

---
 visitor/src/main/java/com/iluwatar/App.java              | 9 +++++++--
 visitor/src/main/java/com/iluwatar/Commander.java        | 5 +++++
 visitor/src/main/java/com/iluwatar/CommanderVisitor.java | 5 +++++
 visitor/src/main/java/com/iluwatar/Sergeant.java         | 5 +++++
 visitor/src/main/java/com/iluwatar/SergeantVisitor.java  | 5 +++++
 visitor/src/main/java/com/iluwatar/Soldier.java          | 5 +++++
 visitor/src/main/java/com/iluwatar/SoldierVisitor.java   | 5 +++++
 7 files changed, 37 insertions(+), 2 deletions(-)

diff --git a/visitor/src/main/java/com/iluwatar/App.java b/visitor/src/main/java/com/iluwatar/App.java
index 63e0eb105..a3836ffef 100644
--- a/visitor/src/main/java/com/iluwatar/App.java
+++ b/visitor/src/main/java/com/iluwatar/App.java
@@ -2,10 +2,15 @@ package com.iluwatar;
 
 /**
  * 
- * Visitor pattern defines mechanism to apply operations (UnitVisitor) on nodes
- * (Unit) in hierarchy. New operations can be added without altering the node
+ * 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 {
 
diff --git a/visitor/src/main/java/com/iluwatar/Commander.java b/visitor/src/main/java/com/iluwatar/Commander.java
index 5d8f994d8..f61df8793 100644
--- a/visitor/src/main/java/com/iluwatar/Commander.java
+++ b/visitor/src/main/java/com/iluwatar/Commander.java
@@ -1,5 +1,10 @@
 package com.iluwatar;
 
+/**
+ * 
+ * Commander
+ *
+ */
 public class Commander extends Unit {
 
 	public Commander(Unit... children) {
diff --git a/visitor/src/main/java/com/iluwatar/CommanderVisitor.java b/visitor/src/main/java/com/iluwatar/CommanderVisitor.java
index 56578b429..edc61c429 100644
--- a/visitor/src/main/java/com/iluwatar/CommanderVisitor.java
+++ b/visitor/src/main/java/com/iluwatar/CommanderVisitor.java
@@ -1,5 +1,10 @@
 package com.iluwatar;
 
+/**
+ * 
+ * CommanderVisitor
+ *
+ */
 public class CommanderVisitor implements UnitVisitor {
 
 	@Override
diff --git a/visitor/src/main/java/com/iluwatar/Sergeant.java b/visitor/src/main/java/com/iluwatar/Sergeant.java
index 488a26ceb..9a0d492d2 100644
--- a/visitor/src/main/java/com/iluwatar/Sergeant.java
+++ b/visitor/src/main/java/com/iluwatar/Sergeant.java
@@ -1,5 +1,10 @@
 package com.iluwatar;
 
+/**
+ * 
+ * Sergeant
+ *
+ */
 public class Sergeant extends Unit {
 
 	public Sergeant(Unit... children) {
diff --git a/visitor/src/main/java/com/iluwatar/SergeantVisitor.java b/visitor/src/main/java/com/iluwatar/SergeantVisitor.java
index 36b8dacc1..bb2d1be4b 100644
--- a/visitor/src/main/java/com/iluwatar/SergeantVisitor.java
+++ b/visitor/src/main/java/com/iluwatar/SergeantVisitor.java
@@ -1,5 +1,10 @@
 package com.iluwatar;
 
+/**
+ * 
+ * SergeantVisitor
+ *
+ */
 public class SergeantVisitor implements UnitVisitor {
 
 	@Override
diff --git a/visitor/src/main/java/com/iluwatar/Soldier.java b/visitor/src/main/java/com/iluwatar/Soldier.java
index b981979d9..09e0a7e9a 100644
--- a/visitor/src/main/java/com/iluwatar/Soldier.java
+++ b/visitor/src/main/java/com/iluwatar/Soldier.java
@@ -1,5 +1,10 @@
 package com.iluwatar;
 
+/**
+ * 
+ * Soldier
+ *
+ */
 public class Soldier extends Unit {
 
 	public Soldier(Unit... children) {
diff --git a/visitor/src/main/java/com/iluwatar/SoldierVisitor.java b/visitor/src/main/java/com/iluwatar/SoldierVisitor.java
index d4eb48990..ff5c91e19 100644
--- a/visitor/src/main/java/com/iluwatar/SoldierVisitor.java
+++ b/visitor/src/main/java/com/iluwatar/SoldierVisitor.java
@@ -1,5 +1,10 @@
 package com.iluwatar;
 
+/**
+ * 
+ * SoldierVisitor
+ *
+ */
 public class SoldierVisitor implements UnitVisitor {
 
 	@Override