iluwatar#107 Event Aggregator example JavaDoc

iluwatar · iluwatar · commit 0364b49870c6 · 2015-08-18T22:37:04.000+03:00
diff --git a/event-aggregator/src/main/java/com/iluwatar/event/aggregator/App.java b/event-aggregator/src/main/java/com/iluwatar/event/aggregator/App.java
@@ -7,14 +7,18 @@
  * 
  * The Event Aggregator pattern channels events from multiple objects 
  * into a single object to simplify registration for clients.
- * 
- * In the example LordBaelish, LordVarys and Scout deliver events to
- * KingsHand. KingsHand, the event aggregator, then delivers the events
- * to KingJoffrey.
+ * <p>
+ * In the example {@link LordBaelish}, {@link LordVarys} and {@link Scout} deliver events to
+ * {@link KingsHand}. {@link KingsHand}, the event aggregator, then delivers the events
+ * to {@link KingJoffrey}.
  *
  */
 public class App {
 
+	/**
+	 * Program entry point
+	 * @param args command line args
+	 */
 	public static void main(String[] args) {
 		
 		KingJoffrey kingJoffrey = new KingJoffrey();
diff --git a/event-aggregator/src/main/java/com/iluwatar/event/aggregator/KingJoffrey.java b/event-aggregator/src/main/java/com/iluwatar/event/aggregator/KingJoffrey.java
@@ -2,7 +2,7 @@
 
 /**
  * 
- * KingJoffrey observes events from KingsHand.
+ * KingJoffrey observes events from {@link KingsHand}.
  *
  */
 public class KingJoffrey implements EventObserver {
diff --git a/event-aggregator/src/main/java/com/iluwatar/event/aggregator/Weekday.java b/event-aggregator/src/main/java/com/iluwatar/event/aggregator/Weekday.java
@@ -1,5 +1,10 @@
 package com.iluwatar.event.aggregator;
 
+/**
+ * 
+ * Weekday enumeration
+ *
+ */
 public enum Weekday {
 	
 	MONDAY("Monday"), TUESDAY("Tuesday"), WEDNESDAY("Wednesday"), THURSDAY("Thursday"), FRIDAY("Friday"), SATURDAY("Saturday"), SUNDAY("Sunday");
diff --git a/event-aggregator/src/test/java/com/iluwatar/event/aggregator/AppTest.java b/event-aggregator/src/test/java/com/iluwatar/event/aggregator/AppTest.java
@@ -3,6 +3,11 @@
 
 import com.iluwatar.event.aggregator.App;
 
+/**
+ * 
+ * Application test
+ *
+ */
 public class AppTest {
 
 	@Test

Original file line number	Diff line number	Diff line change
`@@ -2,7 +2,7 @@`
`2`	`2`
`3`	`3`	`/**`
`4`	`4`	`*`
`5`		`- * KingJoffrey observes events from KingsHand.`
	`5`	`+ * KingJoffrey observes events from {@link KingsHand}.`
`6`	`6`	`*`
`7`	`7`	`*/`
`8`	`8`	`public class KingJoffrey implements EventObserver {`