Adding missing javadocs to TestSubscriber (#1322)

Author: DavidMGross

rxjava-core/src/main/java/rx/observers/TestSubscriber.java

@@ -24,7 +24,7 @@
 import rx.Subscriber;
 
 /**
- * Subscriber usable for unit testing to perform assertions, inspect received events or wrap a mocked
+ * Subscriber usable for unit testing to perform assertions, inspect received events, or wrap a mocked
  * Subscriber.
  */
 public class TestSubscriber<T> extends Subscriber<T> {
@@ -73,10 +73,10 @@ public void onCompleted() {
     }
 
     /**
-     * Get the {@link Notification}s representing each time this subscriber was notified of sequence completion
+     * Get the {@link Notification}s representing each time this Subscriber was notified of sequence completion
      * via {@link #onCompleted}, as a {@link List}.
      *
-     * @return a list of Notifications representing calls to this subscriber's {@link #onCompleted} method
+     * @return a list of Notifications representing calls to this Subscriber's {@link #onCompleted} method
      */
     public List<Notification<T>> getOnCompletedEvents() {
         return testObserver.getOnCompletedEvents();
@@ -93,9 +93,9 @@ public void onError(Throwable e) {
     }
 
     /**
-     * Get the {@link Throwable}s this subscriber was notified of via {@link #onError} as a {@link List}.
+     * Get the {@link Throwable}s this Subscriber was notified of via {@link #onError} as a {@link List}.
      *
-     * @return a list of Throwables passed to this subscriber's {@link #onError} method
+     * @return a list of the Throwables that were passed to this Subscriber's {@link #onError} method
      */
     public List<Throwable> getOnErrorEvents() {
         return testObserver.getOnErrorEvents();
@@ -108,16 +108,16 @@ public void onNext(T t) {
     }
 
     /**
-     * Get the sequence of items observed by this subscriber, as an ordered {@link List}.
+     * Get the sequence of items observed by this Subscriber, as an ordered {@link List}.
      *
-     * @return a list of items observed by this subscriber, in the order in which they were observed
+     * @return a list of items observed by this Subscriber, in the order in which they were observed
      */
     public List<T> getOnNextEvents() {
         return testObserver.getOnNextEvents();
     }
 
     /**
-     * Assert that a particular sequence of items was received in order.
+     * Assert that a particular sequence of items was received by this Subscriber in order.
      *
      * @param items
      *          the sequence of items expected to have been observed
@@ -150,14 +150,24 @@ public void assertUnsubscribed() {
         }
     }
 
+    /**
+     * Assert that this {@code Subscriber} has received no {@code onError} notifications.
+     * 
+     * @throws AssertionError
+     *          if this {@code Subscriber} has received one or more {@code onError} notifications
+     */
     public void assertNoErrors() {
         if (getOnErrorEvents().size() > 0) {
             throw new AssertionError("Unexpected onError events: " + getOnErrorEvents().size(), getOnErrorEvents().get(0));
         }
     }
 
     /**
-     * @warn javadoc missing
+     * Blocks until this Subscriber receives a notification that the Observable is complete (either an
+     * {@code onCompleted} or {@code onError} notification).
+     *
+     * @throws RuntimeException
+     *          if the Subscriber is interrupted before the Observable is able to complete
      */
     public void awaitTerminalEvent() {
         try {
@@ -168,9 +178,15 @@ public void awaitTerminalEvent() {
     }
 
     /**
-     * @warn javadoc missing
+     * Blocks until this Subscriber receives a notification that the Observable is complete (either an
+     * {@code onCompleted} or {@code onError} notification), or until a timeout expires.
+     *
      * @param timeout
+     *          the duration of the timeout
      * @param unit
+     *          the units in which {@code timeout} is expressed
+     * @throws RuntimeException
+     *          if the Subscriber is interrupted before the Observable is able to complete
      */
     public void awaitTerminalEvent(long timeout, TimeUnit unit) {
         try {
@@ -181,9 +197,15 @@ public void awaitTerminalEvent(long timeout, TimeUnit unit) {
     }
 
     /**
-     * @warn javadoc missing
+     * Blocks until this Subscriber receives a notification that the Observable is complete (either an
+     * {@code onCompleted} or {@code onError} notification), or until a timeout expires; if the Subscriber
+     * is interrupted before either of these events take place, this method unsubscribes the Subscriber from the
+     * Observable).
+     *
      * @param timeout
+     *          the duration of the timeout
      * @param unit
+     *          the units in which {@code timeout} is expressed
      */
     public void awaitTerminalEventAndUnsubscribeOnTimeout(long timeout, TimeUnit unit) {
         try {
@@ -194,7 +216,10 @@ public void awaitTerminalEventAndUnsubscribeOnTimeout(long timeout, TimeUnit uni
     }
 
     /**
-     * @warn javadoc missing
+     * Returns the last thread that was in use when an item or notification was received by this Subscriber.
+     *
+     * @return the {@code Thread} on which this Subscriber last received an item or notification from the
+     *         Observable it is subscribed to
      */
     public Thread getLastSeenThread() {
         return lastSeenThread;