2.x: fix minor javadoc errors

Author: akarnokd

src/main/java/io/reactivex/internal/observers/QueueDrainObserver.java

@@ -83,6 +83,7 @@ protected final void fastPathEmit(U value, boolean delayError, Disposable dispos
      * Makes sure the fast-path emits in order.
      * @param value the value to emit or queue up
      * @param delayError if true, errors are delayed until the source has terminated
+     * @param disposable the resource to dispose if the drain terminates
      */
     protected final void fastPathOrderedEmit(U value, boolean delayError, Disposable disposable) {
         final Observer<? super V> s = actual;

src/main/java/io/reactivex/internal/operators/maybe/MaybeFlatMapCompletable.java

@@ -24,7 +24,7 @@
 
 /**
  * Maps the success value of the source MaybeSource into a Completable.
- * @param <T>
+ * @param <T> the value type of the source MaybeSource
  */
 public final class MaybeFlatMapCompletable<T> extends Completable {
 

src/main/java/io/reactivex/internal/operators/single/SingleFlatMapCompletable.java

@@ -24,7 +24,7 @@
 
 /**
  * Maps the success value of the source SingleSource into a Completable.
- * @param <T>
+ * @param <T> the value type of the source SingleSource
  */
 public final class SingleFlatMapCompletable<T> extends Completable {
 

src/main/java/io/reactivex/internal/queue/SpscArrayQueue.java

@@ -35,7 +35,7 @@
  * 2012 - Junchang- BQueue- Efficient and Practical Queuing.pdf <br>
  * </i> This implementation is wait free.
  *
- * @param <E>
+ * @param <E> the element type of the queue
  */
 public final class SpscArrayQueue<E> extends AtomicReferenceArray<E> implements SimplePlainQueue<E> {
     private static final long serialVersionUID = -1296597691183856449L;

src/main/java/io/reactivex/observers/BaseTestConsumer.java

@@ -117,6 +117,7 @@ public final int errorCount() {
      * will capture those potential errors and report it along with the original failure.
      *
      * @param message the message to use
+     * @return AssertionError the prepared AssertionError instance
      */
     protected final AssertionError fail(String message) {
         StringBuilder b = new StringBuilder(64 + message.length());

src/main/java/io/reactivex/subscribers/DefaultSubscriber.java

@@ -37,6 +37,7 @@ public final void onSubscribe(Subscription s) {
 
     /**
      * Requests from the upstream Subscription.
+     * @param n the request amount, positive
      */
     protected final void request(long n) {
         Subscription s = this.s;

src/test/java/io/reactivex/flowable/FlowableEventStream.java

@@ -66,8 +66,9 @@ public static class Event {
         public final Map<String, Object> values;
 
         /**
-         * @param type
-         * @param instanceId
+         * Construct an event with the provided parameters.
+         * @param type the event type
+         * @param instanceId the instance identifier
          * @param values
          *            This does NOT deep-copy, so do not mutate this Map after passing it in.
          */

src/test/java/io/reactivex/flowable/FlowableTests.java

@@ -699,7 +699,7 @@ public void testErrorThrownWithoutErrorHandlerSynchronous() {
      * to rethrow the exception on the thread that the message comes out from the Observable.
      * The OnCompleted behavior in this case is to do nothing."
      *
-     * @throws InterruptedException
+     * @throws InterruptedException if the await is interrupted
      */
     @Test
     @Ignore("Subscribers can't throw")

src/test/java/io/reactivex/internal/operators/flowable/BlockingFlowableNextTest.java

@@ -224,7 +224,7 @@ public void testNextWithCallingHasNextMultipleTimes() {
      * <p/>
      * This results in output such as => a: 1 b: 2 c: 89
      *
-     * @throws Throwable
+     * @throws Throwable some method call is declared throws
      */
     @Test
     public void testNoBufferingOrBlockingOfSequence() throws Throwable {

src/test/java/io/reactivex/internal/operators/flowable/FlowableGroupByTest.java

@@ -171,7 +171,7 @@ public void accept(V v) {
     /**
      * Assert that only a single subscription to a stream occurs and that all events are received.
      *
-     * @throws Throwable
+     * @throws Throwable some method call is declared throws
      */
     @Test
     public void testGroupedEventStream() throws Throwable {

src/test/java/io/reactivex/internal/operators/flowable/FlowableMergeTest.java

@@ -836,7 +836,7 @@ public void onNext(Integer t) {
      * Thus, we must allow all Flowables to be sent. The ScalarSynchronousFlowable use case is an exception to this since
      * we can grab the value synchronously.
      *
-     * @throws InterruptedException
+     * @throws InterruptedException if the await is interrupted
      */
     @Test(timeout = 5000)
     public void testBackpressureBothUpstreamAndDownstreamWithRegularFlowables() throws InterruptedException {

src/test/java/io/reactivex/internal/operators/flowable/FlowableReplayTest.java

@@ -557,7 +557,7 @@ public void testIssue2191_UnsubscribeSource() throws Exception {
     /**
      * Specifically test interaction with a Scheduler with subscribeOn.
      *
-     * @throws Exception
+     * @throws Exception functional interfaces declare throws Exception
      */
     @SuppressWarnings("unchecked")
     @Test
@@ -619,7 +619,7 @@ public void testIssue2191_SchedulerUnsubscribe() throws Exception {
     /**
      * Specifically test interaction with a Scheduler with subscribeOn.
      *
-     * @throws Exception
+     * @throws Exception functional interfaces declare throws Exception
      */
     @SuppressWarnings("unchecked")
     @Test

src/test/java/io/reactivex/internal/operators/observable/BlockingObservableNextTest.java

@@ -230,7 +230,7 @@ public void testNextWithCallingHasNextMultipleTimes() {
      * <p/>
      * This results in output such as => a: 1 b: 2 c: 89
      *
-     * @throws Throwable
+     * @throws Throwable some method call is declared throws
      */
     @Test
     public void testNoBufferingOrBlockingOfSequence() throws Throwable {

src/test/java/io/reactivex/internal/operators/observable/ObservableGroupByTest.java

@@ -171,7 +171,7 @@ public void accept(V v) {
     /**
      * Assert that only a single subscription to a stream occurs and that all events are received.
      *
-     * @throws Throwable
+     * @throws Throwable some method may throw
      */
     @Test
     public void testGroupedEventStream() throws Throwable {

src/test/java/io/reactivex/internal/operators/observable/ObservableMergeTest.java

@@ -772,7 +772,7 @@ public void onNext(Integer t) {
      * Thus, we must allow all Observables to be sent. The ScalarSynchronousObservable use case is an exception to this since
      * we can grab the value synchronously.
      *
-     * @throws InterruptedException
+     * @throws InterruptedException if the await is interrupted
      */
     @Test(timeout = 5000)
     public void testBackpressureBothUpstreamAndDownstreamWithRegularObservables() throws InterruptedException {

src/test/java/io/reactivex/internal/operators/observable/ObservableReplayTest.java

@@ -557,7 +557,7 @@ public void testIssue2191_UnsubscribeSource() throws Exception {
     /**
      * Specifically test interaction with a Scheduler with subscribeOn.
      *
-     * @throws Exception
+     * @throws Exception functional interfaces are declared with throws Exception
      */
     @SuppressWarnings("unchecked")
     @Test
@@ -610,7 +610,7 @@ public void testIssue2191_SchedulerUnsubscribe() throws Exception {
     /**
      * Specifically test interaction with a Scheduler with subscribeOn.
      *
-     * @throws Exception
+     * @throws Exception functional interfaces are declared with throws Exception
      */
     @SuppressWarnings("unchecked")
     @Test

src/test/java/io/reactivex/observable/ObservableEventStream.java

@@ -67,8 +67,9 @@ public static class Event {
         public final Map<String, Object> values;
 
         /**
-         * @param type
-         * @param instanceId
+         * Construct an event with the provided parameters.
+         * @param type the event type
+         * @param instanceId the instance identifier
          * @param values
          *            This does NOT deep-copy, so do not mutate this Map after passing it in.
          */

src/test/java/io/reactivex/observable/ObservableTest.java

@@ -719,7 +719,7 @@ public void testErrorThrownWithoutErrorHandlerSynchronous() {
      * to rethrow the exception on the thread that the message comes out from the Observable.
      * The OnCompleted behavior in this case is to do nothing."
      *
-     * @throws InterruptedException
+     * @throws InterruptedException if the await is interrupted
      */
     @Test
     @Ignore("Subscribers can't throw")

src/test/java/io/reactivex/observers/SerializedObserverTest.java

@@ -250,7 +250,7 @@ public void runConcurrencyTest() {
     /**
      * Test that a notification does not get delayed in the queue waiting for the next event to push it through.
      *
-     * @throws InterruptedException
+     * @throws InterruptedException if the await is interrupted
      */
     @Ignore("this is non-deterministic ... haven't figured out what's wrong with the test yet (benjchristensen: July 2014)")
     @Test
@@ -340,7 +340,7 @@ public void onNext(String t) {
      * The real issue in this example is the async buffer-bloat, so we need backpressure.
      *
      *
-     * @throws InterruptedException
+     * @throws InterruptedException if the await is interrupted
      */
     @Ignore("Demonstrates thread starvation problem. Read JavaDoc")
     @Test
@@ -585,7 +585,7 @@ public void onNext(String args) {
         /**
          * Assert the order of events is correct and return the number of onNext executions.
          *
-         * @param expectedEndingEvent
+         * @param expectedEndingEvent the expected last event
          * @return int count of onNext calls
          * @throws IllegalStateException
          *             If order of events was invalid.

src/test/java/io/reactivex/schedulers/AbstractSchedulerTests.java

@@ -40,6 +40,7 @@ public abstract class AbstractSchedulerTests {
 
     /**
      * The scheduler to test.
+     * @return the Scheduler instance
      */
     protected abstract Scheduler getScheduler();
 
@@ -136,7 +137,7 @@ public String apply(String s) {
     /**
      * The order of execution is nondeterministic.
      *
-     * @throws InterruptedException
+     * @throws InterruptedException if the await is interrupted
      */
     @SuppressWarnings("rawtypes")
     @Test

src/test/java/io/reactivex/subscribers/SerializedSubscriberTest.java

@@ -251,7 +251,7 @@ public void runConcurrencyTest() {
     /**
      * Test that a notification does not get delayed in the queue waiting for the next event to push it through.
      *
-     * @throws InterruptedException
+     * @throws InterruptedException if the await is interrupted
      */
     @Ignore("this is non-deterministic ... haven't figured out what's wrong with the test yet (benjchristensen: July 2014)")
     @Test
@@ -341,7 +341,7 @@ public void onNext(String t) {
      * The real issue in this example is the async buffer-bloat, so we need backpressure.
      *
      *
-     * @throws InterruptedException
+     * @throws InterruptedException if the await is interrupted
      */
     @Ignore("Demonstrates thread starvation problem. Read JavaDoc")
     @Test
@@ -586,7 +586,7 @@ public void onNext(String args) {
         /**
          * Assert the order of events is correct and return the number of onNext executions.
          *
-         * @param expectedEndingEvent
+         * @param expectedEndingEvent the last event
          * @return int count of onNext calls
          * @throws IllegalStateException
          *             If order of events was invalid.