diff --git a/rxjava-core/src/main/java/rx/Observable.java b/rxjava-core/src/main/java/rx/Observable.java index 0cef17b1d3..b274c09b48 100644 --- a/rxjava-core/src/main/java/rx/Observable.java +++ b/rxjava-core/src/main/java/rx/Observable.java @@ -1103,6 +1103,8 @@ public static Observable just(T value) { * Returns an Observable that emits a single item and then completes on a * specified scheduler. *

+ * + *

* This is a scheduler version of {@link Observable#just(Object)}. * * @param value the item to pass to the {@link Observer}'s @@ -1387,7 +1389,6 @@ public static Observable concat(Observable t1, Observable interval(long interval, TimeUnit unit) { /** * Emits an item each time interval (containing a sequential number). *

- * + * * * @param interval interval size in time units (see below) * @param unit time units to use for the interval size @@ -2021,7 +2022,7 @@ public Observable debounce(long timeout, TimeUnit unit) { * Note: If events keep firing faster than the timeout then no data will be * emitted. *

- * + * *

* Information on debounce vs throttle: *

@@ -2081,7 +2082,7 @@ public Observable throttleWithTimeout(long timeout, TimeUnit unit) { * Note: If events keep firing faster than the timeout then no data will be * emitted. *

- * + * *

* Information on debounce vs throttle: *

@@ -2131,7 +2132,7 @@ public Observable throttleFirst(long windowDuration, TimeUnit unit) { * This differs from {@link #throttleLast} in that this only tracks passage * of time whereas {@link #throttleLast} ticks at scheduled intervals. *

- * + * * * @param skipDuration time to wait before sending another item after * emitting the last item @@ -2174,11 +2175,13 @@ public Observable throttleLast(long intervalDuration, TimeUnit unit) { * scheduled interval whereas {@link #throttleFirst} does not tick, it just * tracks passage of time. *

- * + * * * @param intervalDuration duration of windows within which the last item * will be emitted * @param unit the unit of time for the specified interval + * @param scheduler the {@link Scheduler} to use internally to manage the + * timers that handle timeout for each event * @return an Observable that performs the throttle operation * @see RxJava Wiki: throttleLast() * @see #sample(long, TimeUnit, Scheduler) @@ -2227,7 +2230,7 @@ public static Observable from(Future future) { /** * Converts a {@link Future} into an Observable. *

- * + * *

* You can convert any object that supports the {@link Future} interface * into an Observable that emits the return value of the {@link Future#get} @@ -2913,7 +2916,7 @@ public Observable> buffer(long timespan, TimeUnit unit) { /** * Creates an Observable that produces buffers of collected values. *

- * + * *

* This Observable produces connected, non-overlapping buffers, each of a * fixed duration specified by the timespan argument. When the @@ -2966,7 +2969,7 @@ public Observable> buffer(long timespan, TimeUnit unit, int count) { * first). When the source Observable completes or encounters an error, the * current buffer is emitted and the event is propagated. *

- * + * * * @param timespan the period of time each buffer collects values before it * should be emitted and replaced with a new buffer @@ -3016,7 +3019,7 @@ public Observable> buffer(long timespan, long timeshift, TimeUnit unit) * source Observable completes or encounters an error, the current buffer is * emitted and the event is propagated. *

- * + * * * @param timespan the period of time each buffer collects values before it * should be emitted @@ -3153,7 +3156,7 @@ public Observable> window(long timespan, TimeUnit unit) { * source Observable completes or encounters an error, the current window is * emitted and the event is propagated. *

- * + * * * @param timespan the period of time each window collects items before it * should be emitted and replaced with a new window @@ -3201,7 +3204,7 @@ public Observable> window(long timespan, TimeUnit unit, int count) * first). When the source Observable completes or encounters an error, the * current window is emitted and the event is propagated. *

- * + * * * @param timespan the period of time each window collects values before it * should be emitted and replaced with a new window @@ -3251,7 +3254,7 @@ public Observable> window(long timespan, long timeshift, TimeUnit * source Observable completes or encounters an error, the current window is * emitted and the event is propagated. *

- * + * * * @param timespan the period of time each window collects values before it * should be emitted @@ -4239,7 +4242,6 @@ public Observable parallel(Func1, Observable> f) { * {@link Scheduler} * @see RxJava Wiki: parallel() */ - public Observable parallel(final Func1, Observable> f, final Scheduler s) { return OperationParallel.parallel(this, f, s); } @@ -4288,6 +4290,7 @@ public static Observable> parallelMerge(Observable * * @param parallelObservables the number of Observables to merge into + * @param scheduler * @return an Observable of Observables constrained to number defined by * parallelObservables. * @see RxJava Wiki: parallelMerge() @@ -4427,7 +4430,7 @@ public Observable sample(long period, TimeUnit unit) { * Returns an Observable that emits the results of sampling the items * emitted by the source Observable at a specified time interval. *

- * + * * * @param period the sampling rate * @param unit the {@link TimeUnit} in which period is defined @@ -5233,7 +5236,7 @@ public Observable timeout(long timeout, TimeUnit timeUnit, Observable - * + * * * @param timeout maximum duration between values before a timeout occurs * @param timeUnit the unit of time which applies to the @@ -5255,7 +5258,7 @@ public Observable timeout(long timeout, TimeUnit timeUnit, Scheduler schedule * predecessor, the other observable sequence is used to produce future * messages from that point on. *

- * + * * * @param timeout maximum duration between values before a timeout occurs * @param timeUnit the unit of time which applies to the @@ -5289,7 +5292,7 @@ public Observable> timeInterval() { * Records the time interval between consecutive items emitted by an * Observable, using the specified Scheduler to compute time intervals. *

- * + * * * @param scheduler Scheduler used to compute time intervals * @return an Observable that emits time interval information items @@ -5595,6 +5598,8 @@ public void onNext(T args) { } /** * Invokes an action for each item emitted by an Observable. + *

+ * * * @param onNext the action to invoke for each item in the source sequence * @param onError the action to invoke when the source Observable calls @@ -5626,6 +5631,8 @@ public void onNext(T args) { /** * Invokes an action for each item emitted by an Observable. + *

+ * * * @param onNext the action to invoke for each item in the source sequence * @param onError the action to invoke when the source Observable calls @@ -5655,7 +5662,6 @@ public void onNext(T args) { }; - return create(OperationDoOnEach.doOnEach(this, observer)); }