GH-467 - Javadoc on order and user account module events.

src/main/java/org/salespointframework/order/OrderEvents.java

@@ -26,6 +26,13 @@
  */
 public class OrderEvents {
 
+	/**
+	 * Signals the processing of an {@link Order} having been completed, i.e. goods having been sent our, services
+	 * delivered etc. A completed {@link Order} might still be canceled later on.
+	 *
+	 * @author Oliver Drotbohm
+	 * @see OrderCanceled
+	 */
 	@Value(staticConstructor = "of")
 	public static class OrderCompleted implements DomainEvent {
 
@@ -41,6 +48,12 @@ public String toString() {
 		}
 	}
 
+	/**
+	 * Signals an order having been paid. In other words, the step in an {@link Order}'s lifecycle in which we receive the
+	 * customer's money for a particular order.
+	 *
+	 * @author Oliver Drotbohm
+	 */
 	@Value(staticConstructor = "of")
 	public static class OrderPaid implements DomainEvent {
 
@@ -56,6 +69,12 @@ public String toString() {
 		}
 	}
 
+	/**
+	 * Signals an {@link Order} being canceled. Likely to cause other modules in the system to take action to compensate
+	 * for a previously handled {@link OrderCompleted}.
+	 *
+	 * @author Oliver Drotbohm
+	 */
 	@Value(staticConstructor = "of")
 	public static class OrderCanceled implements DomainEvent {
 

src/main/java/org/salespointframework/useraccount/UserAccount.java

@@ -190,6 +190,9 @@ public String toString() {
 	}
 
 	/**
+	 * Signals a new {@link UserAccount} having been created. The actual account can be looked up via
+	 * {@link UserAccountManagement}.
+	 *
 	 * @author Oliver Drotbohm
 	 */
 	@Value(staticConstructor = "of")