1919import rx .subscriptions .CompositeSubscription ;
2020
2121/**
22- * Provides a mechanism for receiving push-based notifications.
22+ * Provides a mechanism for receiving push-based notifications from Observables, and permits manual
23+ * unsubscribing from these Observables.
2324 * <p>
2425 * After a Subscriber calls an {@link Observable}'s {@link Observable#subscribe subscribe} method, the
2526 * {@link Observable} calls the Subscriber's {@link #onNext} method to emit items. A well-behaved
@@ -49,9 +50,11 @@ protected Subscriber(Subscriber<?> op) {
4950 }
5051
5152 /**
52- * Registers an unsubscribe callback.
53+ * Adds a {@link Subscription} to this Subscriber's list of subscriptions if this list is not marked as
54+ * unsubscribed. If the list <em>is</em> marked as unsubscribed, {@code add} will indicate this by
55+ * explicitly unsubscribing the new {@code Subscription} as well.
5356 *
54- * @warn param "s" undescribed
57+ * @param s the {@code Subscription} to add
5558 */
5659 public final void add (Subscription s ) {
5760 cs .add (s );
@@ -63,9 +66,9 @@ public final void unsubscribe() {
6366 }
6467
6568 /**
66- * Indicates whether this Subscriber has unsubscribed from its Observable .
69+ * Indicates whether this Subscriber has unsubscribed from its list of subscriptions .
6770 *
68- * @return {@code true} if this Subscriber has unsubscribed from its Observable , {@code false} otherwise
71+ * @return {@code true} if this Subscriber has unsubscribed from its subscriptions , {@code false} otherwise
6972 */
7073 public final boolean isUnsubscribed () {
7174 return cs .isUnsubscribed ();
0 commit comments