(no commit message)

[utils] / support / test / org / wamblee / test / EventTracker.java

diff --git a/support/test/org/wamblee/test/EventTracker.java b/support/test/org/wamblee/test/EventTracker.java
index e49e671ce2ff765099d1c8f0e5d2bb02db238b88..c35ce45bbb73b48d7842ed9840ddacd2ae013d04 100644 (file)
--- a/support/test/org/wamblee/test/EventTracker.java
+++ b/support/test/org/wamblee/test/EventTracker.java
@@ -27,14 +27,16 @@ import org.apache.commons.logging.LogFactory;
 /**
  * Tracks the occurence of certain events in a test environment. Threads in a
  * test environment tell the event tracker of the occurrence of certain events
- * using {@link #eventOccurred(String)}. Test code inspects the events sent by
- * a thread using {@link #isEventSent(Thread, String)}.
+ * using {@link #eventOccurred(Event)}. Test code inspects the events sent by a
+ * thread using {@link #isEventSent(Thread, Event)}.
  * 
- * A record is kept of every event which is sent. Therefore, the occurence of a
+ * A record is kept of every event which is sent. Therefore, the occurrence of a
  * new event does not erase a previously sent event.
  * 
- * @param <Event> Type of event sent from test code. Usually String will be sufficient. 
- *    The event type must provide a sensible implementation of {@link java.lang.Object#equals(java.lang.Object)}. 
+ * @param <Event>
+ *            Type of event sent from test code. Usually String will be
+ *            sufficient. The event type must provide a sensible implementation
+ *            of {@link java.lang.Object#equals(java.lang.Object)}.
  */
 public class EventTracker<Event> {
 
@@ -104,7 +106,8 @@ public class EventTracker<Event> {
     }
 
     /**
-     * Gets the number of times an event was sent.
+     * Gets the number of times an event was sent summed up
+     * over all threads. 
      * 
      * @param aEvent
      *            Event to check.