Skip to content

Commit f453b3e

Browse files
committed
Remove some javadoc errors; make others more pronounced ;-) (ReactiveX#1266)
1 parent a34cba2 commit f453b3e

File tree

1 file changed

+12
-36
lines changed

1 file changed

+12
-36
lines changed

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

Lines changed: 12 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -1781,8 +1781,6 @@ public final static <T> Observable<T> merge(Observable<? extends T> t1, Observab
17811781
* an Observable to be merged
17821782
* @param t8
17831783
* an Observable to be merged
1784-
* @return an Observable that emits items that are the result of flattening
1785-
* the items emitted by the {@code source} Observables
17861784
* @return an Observable that emits all of the items emitted by the source Observables
17871785
* @see <a href="http://msdn.microsoft.com/en-us/library/hh229099.aspx">MSDN: Observable.Merge</a>
17881786
*/
@@ -2265,8 +2263,6 @@ public static final <K1, K2, T> Observable<GroupedObservable<K2, GroupedObservab
22652263
* @return an Observable that emits a range of sequential Integers
22662264
* @throws IllegalArgumentException
22672265
* if {@code count} is less than zero
2268-
* @throws IllegalArgumentException
2269-
* if {@code start} + {@code count} exceeds {@code Integer.MAX_VALUE}
22702266
* @see <a href="https://github.com/Netflix/RxJava/wiki/Creating-Observables#wiki-range">RxJava Wiki: range()</a>
22712267
* @see <a href="http://msdn.microsoft.com/en-us/library/hh229460.aspx">MSDN: Observable.Range</a>
22722268
*/
@@ -3165,10 +3161,8 @@ public final <R> Observable<R> cast(final Class<R> klass) {
31653161
* <p>
31663162
*
31673163
* @param state
3168-
* FIXME FIXME FIXME
31693164
* @param collector
3170-
* FIXME FIXME FIXME
3171-
* @return FIXME FIXME FIXME
3165+
* @return
31723166
*/
31733167
public final <R> Observable<R> collect(R state, final Action2<R, ? super T> collector) {
31743168
Func2<R, T, R> accumulator = new Func2<R, T, R>() {
@@ -3473,7 +3467,7 @@ public final Observable<T> delaySubscription(long delay, TimeUnit unit, Schedule
34733467
*
34743468
* @return an Observable that emits the items and notifications embedded in the {@link Notification} objects
34753469
* emitted by the source Observable
3476-
* @throws Throwable
3470+
* @throws OnErrorNotImplementedException
34773471
* if the source Observable is not of type {@code Observable<Notification<T>>}
34783472
* @see <a href="https://github.com/Netflix/RxJava/wiki/Observable-Utility-Operators#wiki-dematerialize">RxJava Wiki: dematerialize()</a>
34793473
* @see <a href="http://msdn.microsoft.com/en-us/library/hh229047.aspx">MSDN: Observable.dematerialize</a>
@@ -3735,8 +3729,7 @@ public final void onNext(T args) {
37353729
* those emitted by the source Observable
37363730
* @throws IndexOutOfBoundsException
37373731
* if {@code index} is greater than or equal to the number of items emitted by the source
3738-
* Observable
3739-
* @throws IndexOutOfBoundsException
3732+
* Observable, or
37403733
* if {@code index} is less than 0
37413734
* @see <a href="https://github.com/Netflix/RxJava/wiki/Filtering-Observables#wiki-elementat">RxJava Wiki: elementAt()</a>
37423735
*/
@@ -3908,10 +3901,8 @@ public final <R> Observable<R> flatMap(Func1<? super T, ? extends Observable<? e
39083901
* @param onNext
39093902
* {@link Action1} to execute for each item.
39103903
* @throws IllegalArgumentException
3911-
* if {@code onNext} is null
3912-
* @throws IllegalArgumentException
3913-
* if {@code onError} is null
3914-
* @throws IllegalArgumentException
3904+
* if {@code onNext} is null, or
3905+
* if {@code onError} is null, or
39153906
* if {@code onComplete} is null
39163907
* @see <a href="https://github.com/Netflix/RxJava/wiki/Observable#wiki-onnext-oncompleted-and-onerror">RxJava Wiki: onNext, onCompleted, and onError</a>
39173908
* @since 0.19
@@ -3930,10 +3921,8 @@ public final void forEach(final Action1<? super T> onNext) {
39303921
* @param onError
39313922
* {@link Action1} to execute when an error is emitted.
39323923
* @throws IllegalArgumentException
3933-
* if {@code onNext} is null
3934-
* @throws IllegalArgumentException
3935-
* if {@code onError} is null
3936-
* @throws IllegalArgumentException
3924+
* if {@code onNext} is null, or
3925+
* if {@code onError} is null, or
39373926
* if {@code onComplete} is null
39383927
* @see <a href="https://github.com/Netflix/RxJava/wiki/Observable#wiki-onnext-oncompleted-and-onerror">RxJava Wiki: onNext, onCompleted, and onError</a>
39393928
* @since 0.19
@@ -3954,10 +3943,8 @@ public final void forEach(final Action1<? super T> onNext, final Action1<Throwab
39543943
* @param onComplete
39553944
* {@link Action0} to execute when completion is signalled.
39563945
* @throws IllegalArgumentException
3957-
* if {@code onNext} is null
3958-
* @throws IllegalArgumentException
3959-
* if {@code onError} is null
3960-
* @throws IllegalArgumentException
3946+
* if {@code onNext} is null, or
3947+
* if {@code onError} is null, or
39613948
* if {@code onComplete} is null
39623949
* @see <a href="https://github.com/Netflix/RxJava/wiki/Observable#wiki-onnext-oncompleted-and-onerror">RxJava Wiki: onNext, onCompleted, and onError</a>
39633950
* @since 0.19
@@ -6011,7 +5998,6 @@ public final void onNext(T args) {
60115998
* items and notifications from the Observable.
60125999
*
60136000
* @param onNext
6014-
* FIXME FIXME FIXME
60156001
* @return a {@link Subscription} reference with which the {@link Observer} can stop receiving items before
60166002
* the Observable has finished sending them
60176003
* @throws IllegalArgumentException
@@ -6050,15 +6036,12 @@ public final void onNext(T args) {
60506036
* notifications from the Observable.
60516037
*
60526038
* @param onNext
6053-
* FIXME FIXME FIXME
60546039
* @param onError
6055-
* FIXME FIXME FIXME
60566040
* @return a {@link Subscription} reference with which the {@link Observer} can stop receiving items before
60576041
* the Observable has finished sending them
60586042
* @see <a href="https://github.com/Netflix/RxJava/wiki/Observable#wiki-onnext-oncompleted-and-onerror">RxJava Wiki: onNext, onCompleted, and onError</a>
60596043
* @throws IllegalArgumentException
6060-
* if {@code onNext} is null
6061-
* @throws IllegalArgumentException
6044+
* if {@code onNext} is null, or
60626045
* if {@code onError} is null
60636046
*/
60646047
public final Subscription subscribe(final Action1<? super T> onNext, final Action1<Throwable> onError) {
@@ -6094,18 +6077,13 @@ public final void onNext(T args) {
60946077
* notifications from the Observable.
60956078
*
60966079
* @param onNext
6097-
* FIXME FIXME FIXME
60986080
* @param onError
6099-
* FIXME FIXME FIXME
61006081
* @param onComplete
6101-
* FIXME FIXME FIXME
61026082
* @return a {@link Subscription} reference with which the {@link Observer} can stop receiving items before
61036083
* the Observable has finished sending them
61046084
* @throws IllegalArgumentException
6105-
* if {@code onNext} is null
6106-
* @throws IllegalArgumentException
6107-
* if {@code onError} is null
6108-
* @throws IllegalArgumentException
6085+
* if {@code onNext} is null, or
6086+
* if {@code onError} is null, or
61096087
* if {@code onComplete} is null
61106088
* @see <a href="https://github.com/Netflix/RxJava/wiki/Observable#wiki-onnext-oncompleted-and-onerror">RxJava Wiki: onNext, onCompleted, and onError</a>
61116089
*/
@@ -6145,7 +6123,6 @@ public final void onNext(T args) {
61456123
* Observable.
61466124
*
61476125
* @param observer
6148-
* FIXME FIXME FIXME
61496126
* @return a {@link Subscription} reference with which the {@link Observer} can stop receiving items before
61506127
* the Observable has finished sending them
61516128
* @see <a href="https://github.com/Netflix/RxJava/wiki/Observable#wiki-onnext-oncompleted-and-onerror">RxJava Wiki: onNext, onCompleted, and onError</a>
@@ -7590,7 +7567,6 @@ public ThrowObservable(final Throwable exception) {
75907567
*
75917568
* @param observer
75927569
* an {@link Observer} of this Observable
7593-
* @return a reference to the subscription
75947570
*/
75957571
@Override
75967572
public void call(Subscriber<? super T> observer) {

0 commit comments

Comments
 (0)