Skip to content

Commit bc84882

Browse files
committed
javadoc fixes (countLong, subscriptionDelay, Observables)
1 parent 864dc22 commit bc84882

File tree

2 files changed

+18
-16
lines changed

2 files changed

+18
-16
lines changed

src/main/java/rx/Observable.java

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -3647,9 +3647,9 @@ public final Boolean call(T t1) {
36473647
* </dl>
36483648
*
36493649
* @return an Observable that emits a single item: the number of elements emitted by the source Observable
3650-
* @see <a href="https://github.com/ReactiveX/RxJava/wiki/Mathematical-and-Aggregate-Operators#count-and-longcount">RxJava wiki: count</a>
3650+
* @see <a href="https://github.com/ReactiveX/RxJava/wiki/Mathematical-and-Aggregate-Operators#count-and-countlong">RxJava wiki: count</a>
36513651
* @see <a href="http://msdn.microsoft.com/en-us/library/hh229470.aspx">MSDN: Observable.Count</a>
3652-
* @see #longCount()
3652+
* @see #countLong()
36533653
*/
36543654
public final Observable<Integer> count() {
36553655
return reduce(0, new Func2<Integer, T, Integer>() {
@@ -3670,12 +3670,12 @@ public final Integer call(Integer t1, T t2) {
36703670
* <dd>This operator does not support backpressure because by intent it will receive all values and reduce
36713671
* them to a single {@code onNext}.</dd>
36723672
* <dt><b>Scheduler:</b></dt>
3673-
* <dd>{@code longCount} does not operate by default on a particular {@link Scheduler}.</dd>
3673+
* <dd>{@code countLong} does not operate by default on a particular {@link Scheduler}.</dd>
36743674
* </dl>
36753675
*
36763676
* @return an Observable that emits a single item: the number of items emitted by the source Observable as a
36773677
* 64-bit Long item
3678-
* @see <a href="https://github.com/ReactiveX/RxJava/wiki/Mathematical-and-Aggregate-Operators#count-and-longcount">RxJava wiki: count</a>
3678+
* @see <a href="https://github.com/ReactiveX/RxJava/wiki/Mathematical-and-Aggregate-Operators#count-and-countlong">RxJava wiki: countLong</a>
36793679
* @see <a href="http://msdn.microsoft.com/en-us/library/hh229120.aspx">MSDN: Observable.LongCount</a>
36803680
* @see #count()
36813681
*/
@@ -3973,19 +3973,20 @@ public final Observable<T> delaySubscription(long delay, TimeUnit unit, Schedule
39733973
}
39743974

39753975
/**
3976-
* Returns an Observable that delays the subscription to the source Observable by a given amount of time.
3976+
* Returns an Observable that delays the subscription to the source Observable until a second Observable
3977+
* emits an item.
39773978
* <p>
3978-
* <img width="640" height="310" src="https://raw.github.com/wiki/ReactiveX/RxJava/images/rx-operators/delaySubscription.png" alt="">
3979+
* <img width="640" height="310" src="https://raw.github.com/wiki/ReactiveX/RxJava/images/rx-operators/delaySubscription.o.png" alt="">
39793980
* <dl>
39803981
* <dt><b>Scheduler:</b></dt>
39813982
* <dd>This version of {@code delay} operates by default on the {@code compuation} {@link Scheduler}.</dd>
39823983
* </dl>
39833984
*
3984-
* @param delay
3985-
* the time to delay the subscription
3986-
* @param unit
3987-
* the time unit of {@code delay}
3988-
* @return an Observable that delays the subscription to the source Observable by the given amount
3985+
* @param subscriptionDelay
3986+
* a function that returns an Observable that triggers the subscription to the source Observable
3987+
* once it emits any item
3988+
* @return an Observable that delays the subscription to the source Observable until the Observable returned
3989+
* by {@code subscriptionDelay} emits an item
39893990
* @see <a href="https://github.com/ReactiveX/RxJava/wiki/Observable-Utility-Operators#delaysubscription">RxJava wiki: delaySubscription</a>
39903991
*/
39913992
public final <U> Observable<T> delaySubscription(Func0<? extends Observable<U>> subscriptionDelay) {

src/main/java/rx/observers/Observers.java

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,8 @@ public final void onNext(Object args) {
4646

4747
/**
4848
* Returns an inert {@link Observer} that does nothing in response to the emissions or notifications from
49-
* any {@code Observable} it subscribes to but will throw an exception if its {@link Observer#onError onError} method is called.
49+
* any {@code Observable} it subscribes to but will throw an exception if its
50+
* {@link Observer#onError onError} method is called.
5051
*
5152
* @return an inert {@code Observer}
5253
*/
@@ -58,11 +59,11 @@ public static <T> Observer<T> empty() {
5859
/**
5960
* Creates an {@link Observer} that receives the emissions of any {@code Observable} it subscribes to via
6061
* {@link Observer#onNext onNext} but ignores {@link Observer#onCompleted onCompleted} notifications.
61-
* It will throws an {@link OnErrorNotImplementedException} if {@link Observer#onError onError} is invoked.
62+
* It will throw an {@link OnErrorNotImplementedException} if {@link Observer#onError onError} is invoked.
6263
*
6364
* @param onNext
6465
* a function that handles each item emitted by an {@code Observable}
65-
* @throws IllegalArgument Exception
66+
* @throws IllegalArgumentException
6667
* if {@code onNext} is {@code null}
6768
* @return an {@code Observer} that calls {@code onNext} for each emitted item from the {@code Observable}
6869
* the {@code Observer} subscribes to
@@ -101,7 +102,7 @@ public final void onNext(T args) {
101102
* a function that handles each item emitted by an {@code Observable}
102103
* @param onError
103104
* a function that handles an error notification if one is sent by an {@code Observable}
104-
* @throws IllegalArgument Exception
105+
* @throws IllegalArgumentException
105106
* if either {@code onNext} or {@code onError} are {@code null}
106107
* @return an {@code Observer} that calls {@code onNext} for each emitted item from the {@code Observable}
107108
* the {@code Observer} subscribes to, and calls {@code onError} if the {@code Observable} notifies
@@ -146,7 +147,7 @@ public final void onNext(T args) {
146147
* a function that handles an error notification if one is sent by an {@code Observable}
147148
* @param onComplete
148149
* a function that handles a sequence complete notification if one is sent by an {@code Observable}
149-
* @throws IllegalArgument Exception
150+
* @throws IllegalArgumentException
150151
* if either {@code onNext}, {@code onError}, or {@code onComplete} are {@code null}
151152
* @return an {@code Observer} that calls {@code onNext} for each emitted item from the {@code Observable}
152153
* the {@code Observer} subscribes to, calls {@code onError} if the {@code Observable} notifies

0 commit comments

Comments
 (0)