Skip to content

Commit 3e11dc0

Browse files
levajaakarnokd
authored andcommitted
Fixing JavaDoc warnings (#5637)
1 parent 126e7b5 commit 3e11dc0

26 files changed

+45
-86
lines changed

src/main/java/io/reactivex/Completable.java

-1
Original file line numberDiff line numberDiff line change
@@ -207,7 +207,6 @@ public static Completable concat(Publisher<? extends CompletableSource> sources,
207207
*
208208
* });
209209
* </code></pre>
210-
* <p>
211210
* <dl>
212211
* <dt><b>Scheduler:</b></dt>
213212
* <dd>{@code create} does not operate by default on a particular {@link Scheduler}.</dd>

src/main/java/io/reactivex/Flowable.java

+9-27
Original file line numberDiff line numberDiff line change
@@ -2121,7 +2121,6 @@ public static <T> Flowable<T> fromPublisher(final Publisher<? extends T> source)
21212121

21222122
/**
21232123
* Returns a cold, synchronous, stateless and backpressure-aware generator of values.
2124-
* <p>
21252124
* <dl>
21262125
* <dt><b>Backpressure:</b></dt>
21272126
* <dd>The operator honors downstream backpressure.</dd>
@@ -2148,7 +2147,6 @@ public static <T> Flowable<T> generate(final Consumer<Emitter<T>> generator) {
21482147

21492148
/**
21502149
* Returns a cold, synchronous, stateful and backpressure-aware generator of values.
2151-
* <p>
21522150
* <dl>
21532151
* <dt><b>Backpressure:</b></dt>
21542152
* <dd>The operator honors downstream backpressure.</dd>
@@ -2176,7 +2174,6 @@ public static <T, S> Flowable<T> generate(Callable<S> initialState, final BiCons
21762174

21772175
/**
21782176
* Returns a cold, synchronous, stateful and backpressure-aware generator of values.
2179-
* <p>
21802177
* <dl>
21812178
* <dt><b>Backpressure:</b></dt>
21822179
* <dd>The operator honors downstream backpressure.</dd>
@@ -2206,7 +2203,6 @@ public static <T, S> Flowable<T> generate(Callable<S> initialState, final BiCons
22062203

22072204
/**
22082205
* Returns a cold, synchronous, stateful and backpressure-aware generator of values.
2209-
* <p>
22102206
* <dl>
22112207
* <dt><b>Backpressure:</b></dt>
22122208
* <dd>The operator honors downstream backpressure.</dd>
@@ -2233,7 +2229,6 @@ public static <T, S> Flowable<T> generate(Callable<S> initialState, BiFunction<S
22332229

22342230
/**
22352231
* Returns a cold, synchronous, stateful and backpressure-aware generator of values.
2236-
* <p>
22372232
* <dl>
22382233
* <dt><b>Backpressure:</b></dt>
22392234
* <dd>The operator honors downstream backpressure.</dd>
@@ -5617,7 +5612,6 @@ public final void blockingSubscribe() {
56175612
* If the Flowable emits an error, it is wrapped into an
56185613
* {@link io.reactivex.exceptions.OnErrorNotImplementedException OnErrorNotImplementedException}
56195614
* and routed to the RxJavaPlugins.onError handler.
5620-
* <p>
56215615
* <dl>
56225616
* <dt><b>Backpressure:</b></dt>
56235617
* <dd>The operator consumes the source {@code Flowable} in an unbounded manner
@@ -5676,7 +5670,6 @@ public final void blockingSubscribe(Consumer<? super T> onNext, Consumer<? super
56765670

56775671
/**
56785672
* Subscribes to the source and calls the Subscriber methods <strong>on the current thread</strong>.
5679-
* <p>
56805673
* <dl>
56815674
* <dt><b>Backpressure:</b></dt>
56825675
* <dd>The supplied {@code Subscriber} determines how backpressure is applied.</dd>
@@ -6909,7 +6902,6 @@ public final <R> Flowable<R> concatMapEagerDelayError(Function<? super T, ? exte
69096902
/**
69106903
* Returns a Flowable that concatenate each item emitted by the source Publisher with the values in an
69116904
* Iterable corresponding to that item that is generated by a selector.
6912-
* <p>
69136905
*
69146906
* <dl>
69156907
* <dt><b>Backpressure:</b></dt>
@@ -6939,7 +6931,6 @@ public final <U> Flowable<U> concatMapIterable(Function<? super T, ? extends Ite
69396931
/**
69406932
* Returns a Flowable that concatenate each item emitted by the source Publisher with the values in an
69416933
* Iterable corresponding to that item that is generated by a selector.
6942-
* <p>
69436934
*
69446935
* <dl>
69456936
* <dt><b>Backpressure:</b></dt>
@@ -7091,7 +7082,6 @@ public final <U> Flowable<T> debounce(Function<? super T, ? extends Publisher<U>
70917082
* <img width="640" height="310" src="https://raw.github.com/wiki/ReactiveX/RxJava/images/rx-operators/debounce.png" alt="">
70927083
* <p>
70937084
* Information on debounce vs throttle:
7094-
* <p>
70957085
* <ul>
70967086
* <li><a href="http://drupalmotion.com/article/debounce-and-throttle-visual-explanation">Debounce and Throttle: visual explanation</a></li>
70977087
* <li><a href="http://unscriptable.com/2009/03/20/debouncing-javascript-methods/">Debouncing: javascript methods</a></li>
@@ -7133,7 +7123,6 @@ public final Flowable<T> debounce(long timeout, TimeUnit unit) {
71337123
* <img width="640" height="310" src="https://raw.github.com/wiki/ReactiveX/RxJava/images/rx-operators/debounce.s.png" alt="">
71347124
* <p>
71357125
* Information on debounce vs throttle:
7136-
* <p>
71377126
* <ul>
71387127
* <li><a href="http://drupalmotion.com/article/debounce-and-throttle-visual-explanation">Debounce and Throttle: visual explanation</a></li>
71397128
* <li><a href="http://unscriptable.com/2009/03/20/debouncing-javascript-methods/">Debouncing: javascript methods</a></li>
@@ -7393,7 +7382,6 @@ public final <U, V> Flowable<T> delay(Publisher<U> subscriptionIndicator,
73937382
/**
73947383
* Returns a Flowable that delays the subscription to this Publisher
73957384
* until the other Publisher emits an element or completes normally.
7396-
* <p>
73977385
* <dl>
73987386
* <dt><b>Backpressure:</b></dt>
73997387
* <dd>The operator forwards the backpressure requests to this Publisher once
@@ -8336,7 +8324,7 @@ public final <R> Flowable<R> flatMap(Function<? super T, ? extends Publisher<? e
83368324
* by the source Publisher, where that function returns a Publisher, and then merging those resulting
83378325
* Publishers and emitting the results of this merger, while limiting the maximum number of concurrent
83388326
* subscriptions to these Publishers.
8339-
* <p>
8327+
* <!-- <p> -->
83408328
* <!-- <img width="640" height="310" src="https://raw.github.com/wiki/ReactiveX/RxJava/images/rx-operators/flatMap.png" alt=""> -->
83418329
* <dl>
83428330
* <dt><b>Backpressure:</b></dt>
@@ -8372,7 +8360,7 @@ public final <R> Flowable<R> flatMap(Function<? super T, ? extends Publisher<? e
83728360
* by the source Publisher, where that function returns a Publisher, and then merging those resulting
83738361
* Publishers and emitting the results of this merger, while limiting the maximum number of concurrent
83748362
* subscriptions to these Publishers.
8375-
* <p>
8363+
* <!-- <p> -->
83768364
* <!-- <img width="640" height="310" src="https://raw.github.com/wiki/ReactiveX/RxJava/images/rx-operators/flatMap.png" alt=""> -->
83778365
* <dl>
83788366
* <dt><b>Backpressure:</b></dt>
@@ -8411,7 +8399,7 @@ public final <R> Flowable<R> flatMap(Function<? super T, ? extends Publisher<? e
84118399
* by the source Publisher, where that function returns a Publisher, and then merging those resulting
84128400
* Publishers and emitting the results of this merger, while limiting the maximum number of concurrent
84138401
* subscriptions to these Publishers.
8414-
* <p>
8402+
* <!-- <p> -->
84158403
* <!-- <img width="640" height="310" src="https://raw.github.com/wiki/ReactiveX/RxJava/images/rx-operators/flatMap.png" alt=""> -->
84168404
* <dl>
84178405
* <dt><b>Backpressure:</b></dt>
@@ -8505,7 +8493,7 @@ public final <R> Flowable<R> flatMap(
85058493
* Returns a Flowable that applies a function to each item emitted or notification raised by the source
85068494
* Publisher and then flattens the Publishers returned from these functions and emits the resulting items,
85078495
* while limiting the maximum number of concurrent subscriptions to these Publishers.
8508-
* <p>
8496+
* <!-- <p> -->
85098497
* <!-- <img width="640" height="410" src="https://raw.github.com/wiki/ReactiveX/RxJava/images/rx-operators/mergeMap.nce.png" alt=""> -->
85108498
* <dl>
85118499
* <dt><b>Backpressure:</b></dt>
@@ -8628,7 +8616,7 @@ public final <U, R> Flowable<R> flatMap(Function<? super T, ? extends Publisher<
86288616
* Returns a Flowable that emits the results of a specified function to the pair of values emitted by the
86298617
* source Publisher and a specified collection Publisher, while limiting the maximum number of concurrent
86308618
* subscriptions to these Publishers.
8631-
* <p>
8619+
* <!-- <p> -->
86328620
* <!-- <img width="640" height="390" src="https://raw.github.com/wiki/ReactiveX/RxJava/images/rx-operators/mergeMap.r.png" alt=""> -->
86338621
* <dl>
86348622
* <dt><b>Backpressure:</b></dt>
@@ -8671,7 +8659,7 @@ public final <U, R> Flowable<R> flatMap(Function<? super T, ? extends Publisher<
86718659
* Returns a Flowable that emits the results of a specified function to the pair of values emitted by the
86728660
* source Publisher and a specified collection Publisher, while limiting the maximum number of concurrent
86738661
* subscriptions to these Publishers.
8674-
* <p>
8662+
* <!-- <p> -->
86758663
* <!-- <img width="640" height="390" src="https://raw.github.com/wiki/ReactiveX/RxJava/images/rx-operators/mergeMap.r.png" alt=""> -->
86768664
* <dl>
86778665
* <dt><b>Backpressure:</b></dt>
@@ -8720,7 +8708,7 @@ public final <U, R> Flowable<R> flatMap(final Function<? super T, ? extends Publ
87208708
* Returns a Flowable that emits the results of a specified function to the pair of values emitted by the
87218709
* source Publisher and a specified collection Publisher, while limiting the maximum number of concurrent
87228710
* subscriptions to these Publishers.
8723-
* <p>
8711+
* <!-- <p> -->
87248712
* <!-- <img width="640" height="390" src="https://raw.github.com/wiki/ReactiveX/RxJava/images/rx-operators/mergeMap.r.png" alt=""> -->
87258713
* <dl>
87268714
* <dt><b>Backpressure:</b></dt>
@@ -10111,7 +10099,7 @@ public final Flowable<T> onBackpressureBuffer(int capacity, Action onOverflow) {
1011110099
* cancelling the source, and notifying the producer with {@code onOverflow}. </li>
1011210100
* <li>{@code BackpressureOverflow.Strategy.ON_OVERFLOW_DROP_LATEST} will drop any new items emitted by the producer while
1011310101
* the buffer is full, without generating any {@code onError}. Each drop will however invoke {@code onOverflow}
10114-
* to signal the overflow to the producer.</li>j
10102+
* to signal the overflow to the producer.</li>
1011510103
* <li>{@code BackpressureOverflow.Strategy.ON_OVERFLOW_DROP_OLDEST} will drop the oldest items in the buffer in order to make
1011610104
* room for newly emitted ones. Overflow will not generate an{@code onError}, but each drop will invoke
1011710105
* {@code onOverflow} to signal the overflow to the producer.</li>
@@ -10212,7 +10200,6 @@ public final Flowable<T> onBackpressureDrop(Consumer<? super T> onDrop) {
1021210200
* <p>
1021310201
* Note that due to the nature of how backpressure requests are propagated through subscribeOn/observeOn,
1021410202
* requesting more than 1 from downstream doesn't guarantee a continuous delivery of onNext events.
10215-
* <p>
1021610203
* <dl>
1021710204
* <dt><b>Backpressure:</b></dt>
1021810205
* <dd>The operator honors backpressure from downstream and consumes the source {@code Publisher} in an unbounded
@@ -13125,8 +13112,8 @@ public final Flowable<T> subscribeOn(@NonNull Scheduler scheduler, boolean reque
1312513112
/**
1312613113
* Returns a Flowable that emits the items emitted by the source Publisher or the items of an alternate
1312713114
* Publisher if the source Publisher is empty.
13115+
* <p>
1312813116
* <img width="640" height="255" src="https://raw.github.com/wiki/ReactiveX/RxJava/images/rx-operators/switchifempty.png" alt="">
13129-
* <p/>
1313013117
* <dl>
1313113118
* <dt><b>Backpressure:</b></dt>
1313213119
* <dd>If the source {@code Publisher} is empty, the alternate {@code Publisher} is expected to honor backpressure.
@@ -13953,7 +13940,6 @@ public final Flowable<T> throttleLast(long intervalDuration, TimeUnit unit, Sche
1395313940
* <img width="640" height="305" src="https://raw.github.com/wiki/ReactiveX/RxJava/images/rx-operators/throttleWithTimeout.png" alt="">
1395413941
* <p>
1395513942
* Information on debounce vs throttle:
13956-
* <p>
1395713943
* <ul>
1395813944
* <li><a href="http://drupalmotion.com/article/debounce-and-throttle-visual-explanation">Debounce and Throttle: visual explanation</a></li>
1395913945
* <li><a href="http://unscriptable.com/2009/03/20/debouncing-javascript-methods/">Debouncing: javascript methods</a></li>
@@ -13995,7 +13981,6 @@ public final Flowable<T> throttleWithTimeout(long timeout, TimeUnit unit) {
1399513981
* <img width="640" height="305" src="https://raw.github.com/wiki/ReactiveX/RxJava/images/rx-operators/throttleWithTimeout.s.png" alt="">
1399613982
* <p>
1399713983
* Information on debounce vs throttle:
13998-
* <p>
1399913984
* <ul>
1400013985
* <li><a href="http://drupalmotion.com/article/debounce-and-throttle-visual-explanation">Debounce and Throttle: visual explanation</a></li>
1400113986
* <li><a href="http://unscriptable.com/2009/03/20/debouncing-javascript-methods/">Debouncing: javascript methods</a></li>
@@ -16064,7 +16049,6 @@ public final <U, R> Flowable<R> zipWith(Iterable<U> other, BiFunction<? super T
1606416049
* Returns a Flowable that emits items that are the result of applying a specified function to pairs of
1606516050
* values, one each from the source Publisher and another specified Publisher.
1606616051
* <p>
16067-
* <p>
1606816052
* The operator subscribes to its sources in order they are specified and completes eagerly if
1606916053
* one of the sources is shorter than the rest while cancelling the other sources. Therefore, it
1607016054
* is possible those other sources will never be able to run to completion (and thus not calling
@@ -16112,7 +16096,6 @@ public final <U, R> Flowable<R> zipWith(Publisher<? extends U> other, BiFunction
1611216096
* Returns a Flowable that emits items that are the result of applying a specified function to pairs of
1611316097
* values, one each from the source Publisher and another specified Publisher.
1611416098
* <p>
16115-
* <p>
1611616099
* The operator subscribes to its sources in order they are specified and completes eagerly if
1611716100
* one of the sources is shorter than the rest while cancelling the other sources. Therefore, it
1611816101
* is possible those other sources will never be able to run to completion (and thus not calling
@@ -16163,7 +16146,6 @@ public final <U, R> Flowable<R> zipWith(Publisher<? extends U> other,
1616316146
* Returns a Flowable that emits items that are the result of applying a specified function to pairs of
1616416147
* values, one each from the source Publisher and another specified Publisher.
1616516148
* <p>
16166-
* <p>
1616716149
* The operator subscribes to its sources in order they are specified and completes eagerly if
1616816150
* one of the sources is shorter than the rest while cancelling the other sources. Therefore, it
1616916151
* is possible those other sources will never be able to run to completion (and thus not calling

src/main/java/io/reactivex/Maybe.java

-6
Original file line numberDiff line numberDiff line change
@@ -463,7 +463,6 @@ public static <T> Flowable<T> concatEager(Publisher<? extends MaybeSource<? exte
463463
*
464464
* });
465465
* </code></pre>
466-
* <p>
467466
* <dl>
468467
* <dt><b>Scheduler:</b></dt>
469468
* <dd>{@code create} does not operate by default on a particular {@link Scheduler}.</dd>
@@ -837,7 +836,6 @@ public static <T> Flowable<T> merge(Publisher<? extends MaybeSource<? extends T>
837836
* emitted by the nested {@code MaybeSource}, without any transformation.
838837
* <p>
839838
* <img width="640" height="393" src="https://raw.github.com/wiki/ReactiveX/RxJava/images/rx-operators/Maybe.merge.oo.png" alt="">
840-
* <p>
841839
* <dl>
842840
* <dt><b>Scheduler:</b></dt>
843841
* <dd>{@code merge} does not operate by default on a particular {@link Scheduler}.</dd>
@@ -2271,7 +2269,6 @@ public final Maybe<T> delay(long delay, TimeUnit unit, Scheduler scheduler) {
22712269
* Delays the emission of this Maybe until the given Publisher signals an item or completes.
22722270
* <p>
22732271
* <img width="640" height="450" src="https://raw.github.com/wiki/ReactiveX/RxJava/images/rx-operators/delay.oo.png" alt="">
2274-
* <p>
22752272
* <dl>
22762273
* <dt><b>Backpressure:</b></dt>
22772274
* <dd>The {@code delayIndicator} is consumed in an unbounded manner but is cancelled after
@@ -2301,7 +2298,6 @@ public final <U, V> Maybe<T> delay(Publisher<U> delayIndicator) {
23012298
/**
23022299
* Returns a Maybe that delays the subscription to this Maybe
23032300
* until the other Publisher emits an element or completes normally.
2304-
* <p>
23052301
* <dl>
23062302
* <dt><b>Backpressure:</b></dt>
23072303
* <dd>The {@code Publisher} source is consumed in an unbounded fashion (without applying backpressure).</dd>
@@ -3803,7 +3799,6 @@ public final <E extends MaybeObserver<? super T>> E subscribeWith(E observer) {
38033799
* MaybeSource if the current Maybe is empty.
38043800
* <p>
38053801
* <img width="640" height="445" src="https://raw.github.com/wiki/ReactiveX/RxJava/images/rx-operators/switchifempty.m.png" alt="">
3806-
* <p/>
38073802
* <dl>
38083803
* <dt><b>Scheduler:</b></dt>
38093804
* <dd>{@code switchIfEmpty} does not operate by default on a particular {@link Scheduler}.</dd>
@@ -3826,7 +3821,6 @@ public final Maybe<T> switchIfEmpty(MaybeSource<? extends T> other) {
38263821
* SingleSource if the current Maybe is empty.
38273822
* <p>
38283823
* <img width="640" height="445" src="https://raw.github.com/wiki/ReactiveX/RxJava/images/rx-operators/switchifempty.m.png" alt="">
3829-
* <p/>
38303824
* <dl>
38313825
* <dt><b>Scheduler:</b></dt>
38323826
* <dd>{@code switchIfEmpty} does not operate by default on a particular {@link Scheduler}.</dd>

0 commit comments

Comments
 (0)