Skip to content

Commit 9c44701

Browse files
committed
javadoc enhancements for last-minute 0.20 changes
1 parent 6c8aaa7 commit 9c44701

File tree

1 file changed

+16
-14
lines changed

1 file changed

+16
-14
lines changed

rxjava-core/src/main/java/rx/Observable.java

+16-14
Original file line numberDiff line numberDiff line change
@@ -1110,7 +1110,7 @@ public final static <T> Observable<T> empty() {
11101110
* {@code scheduler}
11111111
* @see <a href="https://github.com/Netflix/RxJava/wiki/Creating-Observables#empty-error-and-never">RxJava wiki: empty</a>
11121112
* @see <a href="http://msdn.microsoft.com/en-us/library/hh229066.aspx">MSDN: Observable.Empty(IScheduler)</a>
1113-
* @deprecated Use subscribeOn to Schedule
1113+
* @deprecated use {@link #subscribeOn} to schedule
11141114
*/
11151115
@Deprecated
11161116
public final static <T> Observable<T> empty(Scheduler scheduler) {
@@ -1160,7 +1160,7 @@ public final static <T> Observable<T> error(Throwable exception) {
11601160
* the specified Scheduler
11611161
* @see <a href="https://github.com/Netflix/RxJava/wiki/Creating-Observables#empty-error-and-never">RxJava wiki: error</a>
11621162
* @see <a href="http://msdn.microsoft.com/en-us/library/hh211711.aspx">MSDN: Observable.Throw</a>
1163-
* @deprecated Use subscribeOn to Schedule
1163+
* @deprecated use {@link #subscribeOn} to schedule
11641164
*/
11651165
@Deprecated
11661166
public final static <T> Observable<T> error(Throwable exception, Scheduler scheduler) {
@@ -1297,7 +1297,7 @@ public final static <T> Observable<T> from(Iterable<? extends T> iterable) {
12971297
* Scheduler
12981298
* @see <a href="https://github.com/Netflix/RxJava/wiki/Creating-Observables#from">RxJava wiki: from</a>
12991299
* @see <a href="http://msdn.microsoft.com/en-us/library/hh212140.aspx">MSDN: Observable.ToObservable</a>
1300-
* @deprecated Use subscribeOn to Schedule the work
1300+
* @deprecated use {@link #subscribeOn} to schedule the work
13011301
*/
13021302
@Deprecated
13031303
public final static <T> Observable<T> from(Iterable<? extends T> iterable, Scheduler scheduler) {
@@ -1319,7 +1319,7 @@ public final static <T> Observable<T> from(Iterable<? extends T> iterable, Sched
13191319
* the type of the item
13201320
* @return an Observable that emits the item
13211321
* @see <a href="https://github.com/Netflix/RxJava/wiki/Creating-Observables#from">RxJava wiki: from</a>
1322-
* @deprecated Use just or item instead
1322+
* @deprecated use {@link #just} instead
13231323
*/
13241324
@Deprecated
13251325
public final static <T> Observable<T> from(T t1) {
@@ -1671,7 +1671,7 @@ public final static <T> Observable<T> from(T[] array) {
16711671
* @return an Observable that emits each item in the source Array
16721672
* @see <a href="https://github.com/Netflix/RxJava/wiki/Creating-Observables#from">RxJava wiki: from</a>
16731673
* @see <a href="http://msdn.microsoft.com/en-us/library/hh212140.aspx">MSDN: Observable.ToObservable</a>
1674-
* @deprecated Use subscribeOn to Schedule the work
1674+
* @deprecated use {@link #subscribeOn} to schedule the work
16751675
*/
16761676
@Deprecated
16771677
public final static <T> Observable<T> from(T[] items, Scheduler scheduler) {
@@ -2116,7 +2116,7 @@ public final static <T> Observable<T> merge(Iterable<? extends Observable<? exte
21162116
* if {@code maxConcurrent} is less than or equal to 0
21172117
* @see <a href="https://github.com/Netflix/RxJava/wiki/Combining-Observables#merge">RxJava wiki: merge</a>
21182118
* @see <a href="http://msdn.microsoft.com/en-us/library/hh244329.aspx">MSDN: Observable.Merge</a>
2119-
* @deprecated Use subscribeOn to Schedule
2119+
* @deprecated use {@link #subscribeOn} to schedule
21202120
*/
21212121
@Deprecated
21222122
public final static <T> Observable<T> merge(Iterable<? extends Observable<? extends T>> sequences, int maxConcurrent, Scheduler scheduler) {
@@ -2144,7 +2144,7 @@ public final static <T> Observable<T> merge(Iterable<? extends Observable<? exte
21442144
* Observables in the Iterable
21452145
* @see <a href="https://github.com/Netflix/RxJava/wiki/Combining-Observables#merge">RxJava wiki: merge</a>
21462146
* @see <a href="http://msdn.microsoft.com/en-us/library/hh244336.aspx">MSDN: Observable.Merge</a>
2147-
* @deprecated Use subscribeOn to Schedule
2147+
* @deprecated use {@link #subscribeOn} to schedule
21482148
*/
21492149
@Deprecated
21502150
public final static <T> Observable<T> merge(Iterable<? extends Observable<? extends T>> sequences, Scheduler scheduler) {
@@ -2502,7 +2502,7 @@ public final static <T> Observable<T> merge(Observable<? extends T>[] sequences)
25022502
* @return an Observable that emits all of the items emitted by the Observables in the Array
25032503
* @see <a href="https://github.com/Netflix/RxJava/wiki/Combining-Observables#merge">RxJava wiki: merge</a>
25042504
* @see <a href="http://msdn.microsoft.com/en-us/library/hh229061.aspx">MSDN: Observable.Merge</a>
2505-
* @deprecated Use subscribeOn to Schedule
2505+
* @deprecated use {@link #subscribeOn} to schedule
25062506
*/
25072507
@Deprecated
25082508
public final static <T> Observable<T> merge(Observable<? extends T>[] sequences, Scheduler scheduler) {
@@ -3235,7 +3235,7 @@ public final static <T, Resource> Observable<T> using(
32353235
* @return the Observable whose lifetime controls the lifetime of the dependent resource object
32363236
* @see <a href="https://github.com/Netflix/RxJava/wiki/Observable-Utility-Operators#using">RxJava wiki: using</a>
32373237
* @see <a href="http://msdn.microsoft.com/en-us/library/hh229585.aspx">MSDN: Observable.Using</a>
3238-
* @deprecated Use replacement `using` method with different overloads.
3238+
* @deprecated use the other {@code using} method with different overloads
32393239
*/
32403240
@Deprecated
32413241
public final static <T, Resource extends Subscription> Observable<T> using(Func0<Resource> resourceFactory, Func1<? super Resource, ? extends Observable<? extends T>> observableFactory) {
@@ -6002,7 +6002,7 @@ public final <TIntermediate, TResult> Observable<TResult> multicast(
60026002
* into the specified {@link Subject}
60036003
* @see <a href="https://github.com/Netflix/RxJava/wiki/Connectable-Observable-Operators#observablepublish-and-observablemulticast">RxJava wiki: Observable.publish and Observable.multicast</a>
60046004
* @see <a href="http://msdn.microsoft.com/en-us/library/hh229708.aspx">MSDN: Observable.Multicast</a>
6005-
* @deprecated Use multicast(Func0<Subject>) instead. This one caused nuanced bugs as it retains state.
6005+
* @deprecated use {@link #multicast(Func0)} instead. This one caused nuanced bugs as it retains state.
60066006
*/
60076007
@Deprecated
60086008
public final <R> ConnectableObservable<R> multicast(final Subject<? super T, ? extends R> subject) {
@@ -6246,7 +6246,7 @@ public final Observable<T> onErrorReturn(Func1<Throwable, ? extends T> resumeFun
62466246
* @return the original Observable, with appropriately modified behavior
62476247
* @see <a href="https://github.com/Netflix/RxJava/wiki/Phantom-Operators#onerrorflatmap">RxJava wiki: onErrorFlatMap</a>
62486248
* @since 0.17
6249-
* @deprecated See https://github.com/Netflix/RxJava/issues/1465
6249+
* @deprecated see https://github.com/Netflix/RxJava/issues/1465
62506250
*/
62516251
@Deprecated
62526252
public final Observable<T> onErrorFlatMap(final Func1<OnErrorThrowable, ? extends Observable<? extends T>> resumeFunction) {
@@ -8052,7 +8052,7 @@ public final Observable<T> startWith(Iterable<T> values) {
80528052
* emitted by the source Observable
80538053
* @see <a href="https://github.com/Netflix/RxJava/wiki/Combining-Observables#startwith">RxJava wiki: startWith</a>
80548054
* @see <a href="http://msdn.microsoft.com/en-us/library/hh229372.aspx">MSDN: Observable.StartWith</a>
8055-
* @deprecated Use subscribeOn to Schedule
8055+
* @deprecated use {@link #subscribeOn} to schedule
80568056
*/
80578057
@Deprecated
80588058
public final Observable<T> startWith(Iterable<T> values, Scheduler scheduler) {
@@ -8338,7 +8338,7 @@ public final Observable<T> startWith(T t1, T t2, T t3, T t4, T t5, T t6, T t7, T
83388338
* emit items emitted by the source Observable.
83398339
* @see <a href="https://github.com/Netflix/RxJava/wiki/Combining-Observables#startwith">RxJava wiki: startWith</a>
83408340
* @see <a href="http://msdn.microsoft.com/en-us/library/hh229372.aspx">MSDN: Observable.StartWith</a>
8341-
* @deprecated Use subscribeOn to Schedule
8341+
* @deprecated use {@link #subscribeOn} to schedule
83428342
*/
83438343
@Deprecated
83448344
public final Observable<T> startWith(T[] values, Scheduler scheduler) {
@@ -10132,6 +10132,7 @@ public final Observable<Observable<T>> window(long timespan, long timeshift, Tim
1013210132
* @return an Observable that emits new windows periodically as a fixed timespan elapses
1013310133
* @see <a href="https://github.com/Netflix/RxJava/wiki/Transforming-Observables#window">RxJava wiki: window</a>
1013410134
* @see <a href="http://msdn.microsoft.com/en-us/library/system.reactive.linq.observable.window.aspx">MSDN: Observable.Window</a>
10135+
* @since 0.20
1013510136
*/
1013610137
public final Observable<Observable<T>> window(long timespan, long timeshift, TimeUnit unit, int count, Scheduler scheduler) {
1013710138
return lift(new OperatorWindowWithTime<T>(timespan, timeshift, unit, count, scheduler));
@@ -10405,7 +10406,8 @@ public final <T2, R> Observable<R> zipWith(Iterable<? extends T2> other, Func2<?
1040510406
* and emits the results of {@code zipFunction} applied to these pairs
1040610407
* @see <a href="https://github.com/Netflix/RxJava/wiki/Combining-Observables#zip">RxJava wiki: zip</a>
1040710408
* @see <a href="http://msdn.microsoft.com/en-us/library/system.reactive.linq.observable.zip.aspx">MSDN: Observable.Zip</a>
10408-
* @deprecated use {@code zipWith} instead. Changed to match naming convention of {@code mergeWith}, {@code concatWith}, etc.
10409+
* @deprecated use {@link #zipWith} instead. Changed to match naming convention of {@link #mergeWith},
10410+
* {@link #concatWith}, etc.
1040910411
*/
1041010412
@Deprecated
1041110413
public final <T2, R> Observable<R> zip(Observable<? extends T2> other, Func2<? super T, ? super T2, ? extends R> zipFunction) {

0 commit comments

Comments
 (0)