Improved comments for mediator example.

Author: iluwatar

mediator/src/main/java/com/iluwatar/Action.java

@@ -1,5 +1,10 @@
 package com.iluwatar;
 
+/**
+ * 
+ * Action enumeration.
+ *
+ */
 public enum Action {
 
 	HUNT, TALE, GOLD, ENEMY;

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

@@ -2,24 +2,29 @@
 
 /**
  * 
- * Mediator encapsulates how set of objects (PartyMember) interact. Instead of
- * referring to each other directly they use the mediator (Party) interface.
+ * Mediator encapsulates how a set of objects (PartyMember) interact. Instead of
+ * referring to each other directly they use a mediator (Party) interface.
  * 
  */
 public class App {
 
 	public static void main(String[] args) {
+		
+		// create party and members
 		Party party = new PartyImpl();
 		Hobbit hobbit = new Hobbit();
 		Wizard wizard = new Wizard();
 		Rogue rogue = new Rogue();
 		Hunter hunter = new Hunter();
 
+		// add party members
 		party.addMember(hobbit);
 		party.addMember(wizard);
 		party.addMember(rogue);
 		party.addMember(hunter);
 
+		// perform actions -> the other party members
+		// are notified by the party
 		hobbit.act(Action.ENEMY);
 		wizard.act(Action.TALE);
 		rogue.act(Action.GOLD);

mediator/src/main/java/com/iluwatar/Hobbit.java

@@ -1,5 +1,10 @@
 package com.iluwatar;
 
+/**
+ * 
+ * Hobbit party member.
+ *
+ */
 public class Hobbit extends PartyMemberBase {
 
 	@Override

mediator/src/main/java/com/iluwatar/Hunter.java

@@ -1,5 +1,10 @@
 package com.iluwatar;
 
+/**
+ * 
+ * Hunter party member.
+ *
+ */
 public class Hunter extends PartyMemberBase {
 
 	@Override

mediator/src/main/java/com/iluwatar/Party.java

@@ -2,7 +2,7 @@
 
 /**
  * 
- * Mediator interface.
+ * Party interface.
  * 
  */
 public interface Party {

mediator/src/main/java/com/iluwatar/PartyImpl.java

@@ -3,6 +3,11 @@
 import java.util.ArrayList;
 import java.util.List;
 
+/**
+ * 
+ * Party implementation.
+ *
+ */
 public class PartyImpl implements Party {
 
 	private List<PartyMember> members;
@@ -25,13 +30,4 @@ public void addMember(PartyMember member) {
 		members.add(member);
 		member.joinedParty(this);
 	}
-
-	// somebody hunts for food, call for dinner
-
-	// somebody spots enemy, alert everybody
-
-	// somebody finds gold, deal the gold with everybody
-
-	// somebody tells a tale, call everybody to listen
-
 }

mediator/src/main/java/com/iluwatar/PartyMemberBase.java

@@ -1,5 +1,10 @@
 package com.iluwatar;
 
+/**
+ * 
+ * Abstract base class for party members.
+ *
+ */
 public abstract class PartyMemberBase implements PartyMember {
 
 	protected Party party;

mediator/src/main/java/com/iluwatar/Rogue.java

@@ -1,5 +1,10 @@
 package com.iluwatar;
 
+/**
+ * 
+ * Rogue party member.
+ *
+ */
 public class Rogue extends PartyMemberBase {
 
 	@Override

mediator/src/main/java/com/iluwatar/Wizard.java

@@ -1,5 +1,10 @@
 package com.iluwatar;
 
+/**
+ * 
+ * Wizard party member.
+ *
+ */
 public class Wizard extends PartyMemberBase {
 
 	@Override