More work on ReactiveX#1322 (missing javadocs)

DavidMGross · DavidMGross · commit b504e6c518e7 · 2014-06-23T09:48:32.000-07:00
diff --git a/rxjava-core/src/main/java/rx/Observable.java b/rxjava-core/src/main/java/rx/Observable.java
@@ -7779,7 +7779,6 @@ public final BlockingObservable<T> toBlocking() {
      * <p>
      * {@code toList} does not operate by default on a particular {@link Scheduler}.
      * 
-     * @warn description may be out-of-date
      * @return an Observable that emits a single item: a List containing all of the items emitted by the source
      *         Observable
      * @see <a href="https://github.com/Netflix/RxJava/wiki/Mathematical-and-Aggregate-Operators#tolist">RxJava Wiki: toList()</a>
diff --git a/rxjava-core/src/main/java/rx/Subscriber.java b/rxjava-core/src/main/java/rx/Subscriber.java
@@ -19,7 +19,8 @@
 import rx.subscriptions.CompositeSubscription;
 
 /**
- * Provides a mechanism for receiving push-based notifications.
+ * Provides a mechanism for receiving push-based notifications from Observables, and permits manual
+ * unsubscribing from these Observables.
  * <p>
  * After a Subscriber calls an {@link Observable}'s {@link Observable#subscribe subscribe} method, the
  * {@link Observable} calls the Subscriber's {@link #onNext} method to emit items. A well-behaved
@@ -49,9 +50,11 @@ protected Subscriber(Subscriber<?> op) {
     }
 
     /**
-     * Registers an unsubscribe callback.
+     * Adds a {@link Subscription} to this Subscriber's list of subscriptions if this list is not marked as
+     * unsubscribed. If the list <em>is</em> marked as unsubscribed, {@code add} will indicate this by
+     * explicitly unsubscribing the new {@code Subscription} as well.
      *
-     * @warn param "s" undescribed
+     * @param s the {@code Subscription} to add
      */
     public final void add(Subscription s) {
         cs.add(s);
@@ -63,9 +66,9 @@ public final void unsubscribe() {
     }
 
     /**
-     * Indicates whether this Subscriber has unsubscribed from its Observable.
+     * Indicates whether this Subscriber has unsubscribed from its list of subscriptions.
      * 
-     * @return {@code true} if this Subscriber has unsubscribed from its Observable, {@code false} otherwise
+     * @return {@code true} if this Subscriber has unsubscribed from its subscriptions, {@code false} otherwise
      */
     public final boolean isUnsubscribed() {
         return cs.isUnsubscribed();
diff --git a/rxjava-core/src/main/java/rx/internal/util/SubscriptionList.java b/rxjava-core/src/main/java/rx/internal/util/SubscriptionList.java
@@ -72,6 +72,10 @@ public void add(final Subscription s) {
         }
     }
 
+    /**
+     * Unsubscribe from all of the subscriptions in the list, which stops the receipt of notifications on
+     * the associated {@code Subscriber}.
+     */
     @Override
     public void unsubscribe() {
         synchronized (this) {
@@ -84,10 +88,6 @@ public void unsubscribe() {
         unsubscribeFromAll(subscriptions);
     }
 
-    /**
-     * @warn javadoc missing
-     * @param subscriptions
-     */
     private static void unsubscribeFromAll(Collection<Subscription> subscriptions) {
         if (subscriptions == null) {
             return;

Original file line number	Diff line number	Diff line change
`@@ -7779,7 +7779,6 @@ public final BlockingObservable<T> toBlocking() {`
`7779`	`7779`	`* <p>`
`7780`	`7780`	`* {@code toList} does not operate by default on a particular {@link Scheduler}.`
`7781`	`7781`	`*`
`7782`		`- * @warn description may be out-of-date`
`7783`	`7782`	`* @return an Observable that emits a single item: a List containing all of the items emitted by the source`
`7784`	`7783`	`* Observable`
`7785`	`7784`	`* @see <a href="https://github.com/Netflix/RxJava/wiki/Mathematical-and-Aggregate-Operators#tolist">RxJava Wiki: toList()</a>`
Original file line number	Diff line number	Diff line change
`@@ -72,6 +72,10 @@ public void add(final Subscription s) {`
`72`	`72`	`}`
`73`	`73`	`}`
`74`	`74`
	`75`	`+ /**`
	`76`	`+ * Unsubscribe from all of the subscriptions in the list, which stops the receipt of notifications on`
	`77`	`+ * the associated {@code Subscriber}.`
	`78`	`+ */`
`75`	`79`	`@Override`
`76`	`80`	`public void unsubscribe() {`
`77`	`81`	`synchronized (this) {`
`@@ -84,10 +88,6 @@ public void unsubscribe() {`
`84`	`88`	`unsubscribeFromAll(subscriptions);`
`85`	`89`	`}`
`86`	`90`
`87`		`- /**`
`88`		`- * @warn javadoc missing`
`89`		`- * @param subscriptions`
`90`		`- */`
`91`	`91`	`private static void unsubscribeFromAll(Collection<Subscription> subscriptions) {`
`92`	`92`	`if (subscriptions == null) {`
`93`	`93`	`return;`