Skip to content

Commit 69bc312

Browse files
committed
more javadoc changes to correspond with recent method changes
1 parent 86328ab commit 69bc312

File tree

1 file changed

+18
-12
lines changed

1 file changed

+18
-12
lines changed

src/main/java/rx/Observable.java

Lines changed: 18 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -4724,7 +4724,7 @@ public final void forEach(final Action1<? super T> onNext, final Action1<Throwab
47244724
* @return an {@code Observable} that emits {@link GroupedObservable}s, each of which corresponds to a
47254725
* unique key value and each of which emits those items from the source Observable that share that
47264726
* key value
4727-
* @see <a href="https://github.com/ReactiveX/RxJava/wiki/Transforming-Observables#groupby-and-groupbyuntil">RxJava wiki: groupBy</a>
4727+
* @see <a href="https://github.com/ReactiveX/RxJava/wiki/Transforming-Observables#groupby">RxJava wiki: groupBy</a>
47284728
* @see <a href="http://msdn.microsoft.com/en-us/library/system.reactive.linq.observable.groupby.aspx">MSDN: Observable.GroupBy</a>
47294729
*/
47304730
public final <K, R> Observable<GroupedObservable<K, R>> groupBy(final Func1<? super T, ? extends K> keySelector, final Func1<? super T, ? extends R> elementSelector) {
@@ -4741,6 +4741,10 @@ public final <K, R> Observable<GroupedObservable<K, R>> groupBy(final Func1<? su
47414741
* is subscribed to. For this reason, in order to avoid memory leaks, you should not simply ignore those
47424742
* {@code GroupedObservable}s that do not concern you. Instead, you can signal to them that they may
47434743
* discard their buffers by applying an operator like {@link #take}{@code (0)} to them.
4744+
* <dl>
4745+
* <dt><b>Scheduler:</b></dt>
4746+
* <dd>{@code groupBy} does not operate by default on a particular {@link Scheduler}.</dd>
4747+
* </dl>
47444748
*
47454749
* @param keySelector
47464750
* a function that extracts the key for each item
@@ -4749,7 +4753,7 @@ public final <K, R> Observable<GroupedObservable<K, R>> groupBy(final Func1<? su
47494753
* @return an {@code Observable} that emits {@link GroupedObservable}s, each of which corresponds to a
47504754
* unique key value and each of which emits those items from the source Observable that share that
47514755
* key value
4752-
* @see <a href="https://github.com/ReactiveX/RxJava/wiki/Transforming-Observables#groupby-and-groupbyuntil">RxJava wiki: groupBy</a>
4756+
* @see <a href="https://github.com/ReactiveX/RxJava/wiki/Transforming-Observables#groupby">RxJava wiki: groupBy</a>
47534757
* @see <a href="http://msdn.microsoft.com/en-us/library/system.reactive.linq.observable.groupby.aspx">MSDN: Observable.GroupBy</a>
47544758
*/
47554759
public final <K> Observable<GroupedObservable<K, T>> groupBy(final Func1<? super T, ? extends K> keySelector) {
@@ -5697,8 +5701,8 @@ public final Observable<T> repeat(final long count, Scheduler scheduler) {
56975701
/**
56985702
* Returns an Observable that emits the same values as the source Observable with the exception of an
56995703
* {@code onCompleted}. An {@code onCompleted} notification from the source will result in the emission of
5700-
* a {@link Notification} to the Observable provided as an argument to the {@code notificationHandler}
5701-
* function. If the Observable returned {@code onCompletes} or {@code onErrors} then {@code repeatWhen} will
5704+
* a {@link void} item to the Observable provided as an argument to the {@code notificationHandler}
5705+
* function. If that Observable calls {@code onComplete} or {@code onError} then {@code repeatWhen} will
57025706
* call {@code onCompleted} or {@code onError} on the child subscription. Otherwise, this Observable will
57035707
* resubscribe to the source Observable, on a particular Scheduler.
57045708
* <p>
@@ -5734,8 +5738,8 @@ public Void call(Notification<?> notification) {
57345738
/**
57355739
* Returns an Observable that emits the same values as the source Observable with the exception of an
57365740
* {@code onCompleted}. An {@code onCompleted} notification from the source will result in the emission of
5737-
* a {@link Notification} to the Observable provided as an argument to the {@code notificationHandler}
5738-
* function. If the Observable returned {@code onCompletes} or {@code onErrors} then {@code repeatWhen} will
5741+
* a {@link void} item to the Observable provided as an argument to the {@code notificationHandler}
5742+
* function. If that Observable calls {@code onComplete} or {@code onError} then {@code repeatWhen} will
57395743
* call {@code onCompleted} or {@code onError} on the child subscription. Otherwise, this Observable will
57405744
* resubscribe to the source observable.
57415745
* <p>
@@ -6433,8 +6437,8 @@ public final Observable<T> retry(Func2<Integer, Throwable, Boolean> predicate) {
64336437
/**
64346438
* Returns an Observable that emits the same values as the source observable with the exception of an
64356439
* {@code onError}. An {@code onError} notification from the source will result in the emission of a
6436-
* {@link Notification} to the Observable provided as an argument to the {@code notificationHandler}
6437-
* function. If the Observable returned {@code onCompletes} or {@code onErrors} then {@code retry} will call
6440+
* {@link Throwable} item to the Observable provided as an argument to the {@code notificationHandler}
6441+
* function. If that Observable calls {@code onComplete} or {@code onError} then {@code retry} will call
64386442
* {@code onCompleted} or {@code onError} on the child subscription. Otherwise, this Observable will
64396443
* resubscribe to the source Observable.
64406444
* <p>
@@ -6494,10 +6498,12 @@ public Throwable call(Notification<?> notification) {
64946498
}
64956499

64966500
/**
6497-
* Returns an Observable that emits the same values as the source observable with the exception of an {@code onError}.
6498-
* An onError will emit a {@link Notification} to the observable provided as an argument to the notificationHandler
6499-
* func. If the observable returned {@code onCompletes} or {@code onErrors} then retry will call {@code onCompleted}
6500-
* or {@code onError} on the child subscription. Otherwise, this observable will resubscribe to the source observable, on a particular Scheduler.
6501+
* Returns an Observable that emits the same values as the source observable with the exception of an
6502+
* {@code onError}. An {@code onError} will cause the emission of the {@link Throwable} that cause the
6503+
* error to the Observable returned from {@code notificationHandler}. If that Observable calls
6504+
* {@code onComplete} or {@code onError} then {@code retry} will call {@code onCompleted} or {@code onError}
6505+
* on the child subscription. Otherwise, this Observable will resubscribe to the source observable, on a
6506+
* particular Scheduler.
65016507
* <p>
65026508
* <img width="640" height="430" src="https://raw.github.com/wiki/ReactiveX/RxJava/images/rx-operators/retryWhen.f.png" alt="">
65036509
* <p>

0 commit comments

Comments
 (0)