Skip to content

Commit 0a5f884

Browse files
akarnokdakarnokd
authored
1.x: add missing javadoc elements, fix some descriptions (ReactiveX#4039)
* 1.x: add missing javadoc elements, fix some descriptions * Fix copy-paste error in Completable
1 parent b8bccd9 commit 0a5f884

5 files changed

Lines changed: 339 additions & 67 deletions

File tree

‎src/main/java/rx/Completable.java‎

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -474,7 +474,7 @@ public void call(CompletableSubscriber s) {
474474
/**
475475
* Returns a Completable instance that runs the given Action0 for each subscriber and
476476
* emits either an unchecked exception or simply completes.
477-
* @param run the runnable to run for each subscriber
477+
* @param action the Action0 to run for each subscriber
478478
* @return the new Completable instance
479479
* @throws NullPointerException if run is null
480480
*/
@@ -725,6 +725,7 @@ public static Completable mergeDelayError(Observable<? extends Completable> sour
725725
* observable or any of the inner Completables until all of
726726
* them terminate in a way or another.
727727
* @param sources the sequence of Completables
728+
* @param maxConcurrency the maximum number of simultaneous subscriptions to the source Completables.
728729
* @return the new Completable instance
729730
* @throws NullPointerException if sources is null
730731
*/
@@ -764,10 +765,11 @@ public static Completable timer(long delay, TimeUnit unit) {
764765
}
765766

766767
/**
767-
* Returns a Completable instance that fires its onComplete event after the given delay elapsed
768+
* Returns a Completable instance that fires its onCompleted event after the given delay elapsed
768769
* by using the supplied scheduler.
769770
* @param delay the delay time
770771
* @param unit the delay unit
772+
* @param scheduler the scheduler to use to emit the onCompleted event
771773
* @return the new Completable instance
772774
*/
773775
public static Completable timer(final long delay, final TimeUnit unit, final Scheduler scheduler) {
@@ -813,6 +815,7 @@ static NullPointerException toNpe(Throwable ex) {
813815
* <p>
814816
* This overload performs an eager unsubscription before the terminal event is emitted.
815817
*
818+
* @param <R> the resource type
816819
* @param resourceFunc0 the supplier that returns a resource to be managed.
817820
* @param completableFunc1 the function that given a resource returns a Completable instance that will be subscribed to
818821
* @param disposer the consumer that disposes the resource created by the resource supplier
@@ -832,6 +835,7 @@ public static <R> Completable using(Func0<R> resourceFunc0,
832835
* If this overload performs a lazy unsubscription after the terminal event is emitted.
833836
* Exceptions thrown at this time will be delivered to RxJavaPlugins only.
834837
*
838+
* @param <R> the resource type
835839
* @param resourceFunc0 the supplier that returns a resource to be managed
836840
* @param completableFunc1 the function that given a resource returns a non-null
837841
* Completable instance that will be subscribed to
@@ -1108,6 +1112,7 @@ public final Completable compose(CompletableTransformer transformer) {
11081112
* propagated to the downstream subscriber and will result in skipping the subscription of the
11091113
* Observable.
11101114
*
1115+
* @param <T> the value type of the next Observable
11111116
* @param next the Observable to subscribe after this Completable is completed, not null
11121117
* @return Observable that composes this Completable and next
11131118
* @throws NullPointerException if next is null
@@ -1127,6 +1132,7 @@ public final <T> Observable<T> andThen(Observable<T> next) {
11271132
* <dd>{@code andThen} does not operate by default on a particular {@link Scheduler}.</dd>
11281133
* </dl>
11291134
*
1135+
* @param <T> the value type of the next Single
11301136
* @param next the Single to subscribe after this Completable is completed, not null
11311137
* @return Single that composes this Completable and next
11321138
*/
@@ -1421,6 +1427,7 @@ public final Completable endWith(Completable other) {
14211427
/**
14221428
* Returns an Observable that first runs this Completable instance and
14231429
* resumes with the given next Observable.
1430+
* @param <T> the value type of the next Observable
14241431
* @param next the next Observable to continue
14251432
* @return the new Observable instance
14261433
* @deprecated Use {@link #andThen(rx.Observable)} instead.
@@ -1485,6 +1492,8 @@ public void onSubscribe(Subscription d) {
14851492
/**
14861493
* Subscribes to this Completable instance and blocks until it terminates or the specified timeout
14871494
* elapses, then returns null for normal termination or the emitted exception if any.
1495+
* @param timeout the time amount to wait for the terminal event
1496+
* @param unit the time unit of the timeout parameter
14881497
* @return the throwable if this terminated with an error, null otherwise
14891498
* @throws RuntimeException that wraps an InterruptedException if the wait is interrupted or
14901499
* TimeoutException if the specified timeout elapsed before it
@@ -1845,6 +1854,7 @@ public final Completable startWith(Completable other) {
18451854
/**
18461855
* Returns an Observable which first delivers the events
18471856
* of the other Observable then runs this Completable.
1857+
* @param <T> the value type of the starting other Observable
18481858
* @param other the other Observable to run first
18491859
* @return the new Observable instance
18501860
* @throws NullPointerException if other is null
@@ -2201,6 +2211,7 @@ public final Completable timeout0(long timeout, TimeUnit unit, Scheduler schedul
22012211

22022212
/**
22032213
* Allows fluent conversion to another type via a function callback.
2214+
* @param <U> the output type as determined by the converter function
22042215
* @param converter the function called with this which should return some other value.
22052216
* @return the converted value
22062217
* @throws NullPointerException if converter is null
@@ -2212,6 +2223,7 @@ public final <U> U to(Func1<? super Completable, U> converter) {
22122223
/**
22132224
* Returns an Observable which when subscribed to subscribes to this Completable and
22142225
* relays the terminal events to the subscriber.
2226+
* @param <T> the target type of the Observable
22152227
* @return the new Observable created
22162228
*/
22172229
public final <T> Observable<T> toObservable() {
@@ -2226,6 +2238,7 @@ public void call(Subscriber<? super T> s) {
22262238
/**
22272239
* Converts this Completable into a Single which when this Completable completes normally,
22282240
* calls the given supplier and emits its returned value through onSuccess.
2241+
* @param <T> the value type of the resulting Single
22292242
* @param completionValueFunc0 the value supplier called when this Completable completes normally
22302243
* @return the new Single instance
22312244
* @throws NullPointerException if completionValueFunc0 is null
@@ -2273,6 +2286,7 @@ public void onSubscribe(Subscription d) {
22732286
/**
22742287
* Converts this Completable into a Single which when this Completable completes normally,
22752288
* emits the given value through onSuccess.
2289+
* @param <T> the value type of the resulting Single
22762290
* @param completionValue the value to emit when this Completable completes normally
22772291
* @return the new Single instance
22782292
* @throws NullPointerException if completionValue is null

0 commit comments

Comments
 (0)