iluwatar#107 Improve JavaDoc for Mediator example

iluwatar · iluwatar · commit 252f93899f8f · 2015-08-19T22:12:05.000+03:00
diff --git a/mediator/src/main/java/com/iluwatar/mediator/App.java b/mediator/src/main/java/com/iluwatar/mediator/App.java
@@ -1,33 +1,37 @@
-package com.iluwatar.mediator;
-
-/**
- * 
- * 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);
-		hunter.act(Action.HUNT);
-	}
-}
+package com.iluwatar.mediator;
+
+/**
+ * 
+ * Mediator encapsulates how a set of objects ({@link PartyMember}) interact. Instead of
+ * referring to each other directly they use a mediator ({@link Party}) interface.
+ * 
+ */
+public class App {
+
+	/**
+	 * Program entry point
+	 * @param args command line args
+	 */
+	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);
+		hunter.act(Action.HUNT);
+	}
+}
diff --git a/mediator/src/main/java/com/iluwatar/mediator/PartyMember.java b/mediator/src/main/java/com/iluwatar/mediator/PartyMember.java
@@ -1,15 +1,15 @@
-package com.iluwatar.mediator;
-
-/**
- * 
- * Interface for party members interacting with Party.
- * 
- */
-public interface PartyMember {
-
-	void joinedParty(Party party);
-
-	void partyAction(Action action);
-
-	void act(Action action);
-}
+package com.iluwatar.mediator;
+
+/**
+ * 
+ * Interface for party members interacting with {@link Party}.
+ * 
+ */
+public interface PartyMember {
+
+	void joinedParty(Party party);
+
+	void partyAction(Action action);
+
+	void act(Action action);
+}
diff --git a/mediator/src/test/java/com/iluwatar/mediator/AppTest.java b/mediator/src/test/java/com/iluwatar/mediator/AppTest.java
@@ -1,14 +1,19 @@
-package com.iluwatar.mediator;
-
-import org.junit.Test;
-
-import com.iluwatar.mediator.App;
-
-public class AppTest {
-
-	@Test
-	public void test() {
-		String[] args = {};
-		App.main(args);
-	}
-}
+package com.iluwatar.mediator;
+
+import org.junit.Test;
+
+import com.iluwatar.mediator.App;
+
+/**
+ * 
+ * Application test
+ *
+ */
+public class AppTest {
+
+	@Test
+	public void test() {
+		String[] args = {};
+		App.main(args);
+	}
+}
