Skip to content

Commit

Permalink
Fixing JavaDoc warnings (#5637)
Browse files Browse the repository at this point in the history
  • Loading branch information
@levaja @akarnokd
levaja authored and akarnokd committed Oct 3, 2017
1 parent 126e7b5 commit 3e11dc0
Show file tree
Hide file tree
Showing 26 changed files with 45 additions and 86 deletions.
1 change: 0 additions & 1 deletion src/main/java/io/reactivex/Completable.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -207,7 +207,6 @@ public static Completable concat(Publisher<? extends CompletableSource> sources,
*
* });
* </code></pre>
* <p>
* <dl>
* <dt><b>Scheduler:</b></dt>
* <dd>{@code create} does not operate by default on a particular {@link Scheduler}.</dd>
Expand Down
36 changes: 9 additions & 27 deletions src/main/java/io/reactivex/Flowable.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2121,7 +2121,6 @@ public static <T> Flowable<T> fromPublisher(final Publisher<? extends T> source)

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

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

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

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

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

/**
* Subscribes to the source and calls the Subscriber methods <strong>on the current thread</strong>.
* <p>
* <dl>
* <dt><b>Backpressure:</b></dt>
* <dd>The supplied {@code Subscriber} determines how backpressure is applied.</dd>
Expand Down Expand Up @@ -6909,7 +6902,6 @@ public final <R> Flowable<R> concatMapEagerDelayError(Function<? super T, ? exte
/**
* Returns a Flowable that concatenate each item emitted by the source Publisher with the values in an
* Iterable corresponding to that item that is generated by a selector.
* <p>
*
* <dl>
* <dt><b>Backpressure:</b></dt>
Expand Down Expand Up @@ -6939,7 +6931,6 @@ public final <U> Flowable<U> concatMapIterable(Function<? super T, ? extends Ite
/**
* Returns a Flowable that concatenate each item emitted by the source Publisher with the values in an
* Iterable corresponding to that item that is generated by a selector.
* <p>
*
* <dl>
* <dt><b>Backpressure:</b></dt>
Expand Down Expand Up @@ -7091,7 +7082,6 @@ public final <U> Flowable<T> debounce(Function<? super T, ? extends Publisher<U>
* <img width="640" height="310" src="https://raw.github.com/wiki/ReactiveX/RxJava/images/rx-operators/debounce.png" alt="">
* <p>
* Information on debounce vs throttle:
* <p>
* <ul>
* <li><a href="http://drupalmotion.com/article/debounce-and-throttle-visual-explanation">Debounce and Throttle: visual explanation</a></li>
* <li><a href="http://unscriptable.com/2009/03/20/debouncing-javascript-methods/">Debouncing: javascript methods</a></li>
Expand Down Expand Up @@ -7133,7 +7123,6 @@ public final Flowable<T> debounce(long timeout, TimeUnit unit) {
* <img width="640" height="310" src="https://raw.github.com/wiki/ReactiveX/RxJava/images/rx-operators/debounce.s.png" alt="">
* <p>
* Information on debounce vs throttle:
* <p>
* <ul>
* <li><a href="http://drupalmotion.com/article/debounce-and-throttle-visual-explanation">Debounce and Throttle: visual explanation</a></li>
* <li><a href="http://unscriptable.com/2009/03/20/debouncing-javascript-methods/">Debouncing: javascript methods</a></li>
Expand Down Expand Up @@ -7393,7 +7382,6 @@ public final <U, V> Flowable<T> delay(Publisher<U> subscriptionIndicator,
/**
* Returns a Flowable that delays the subscription to this Publisher
* until the other Publisher emits an element or completes normally.
* <p>
* <dl>
* <dt><b>Backpressure:</b></dt>
* <dd>The operator forwards the backpressure requests to this Publisher once
Expand Down Expand Up @@ -8336,7 +8324,7 @@ public final <R> Flowable<R> flatMap(Function<? super T, ? extends Publisher<? e
* by the source Publisher, where that function returns a Publisher, and then merging those resulting
* Publishers and emitting the results of this merger, while limiting the maximum number of concurrent
* subscriptions to these Publishers.
* <p>
* <!-- <p> -->
* <!-- <img width="640" height="310" src="https://raw.github.com/wiki/ReactiveX/RxJava/images/rx-operators/flatMap.png" alt=""> -->
* <dl>
* <dt><b>Backpressure:</b></dt>
Expand Down Expand Up @@ -8372,7 +8360,7 @@ public final <R> Flowable<R> flatMap(Function<? super T, ? extends Publisher<? e
* by the source Publisher, where that function returns a Publisher, and then merging those resulting
* Publishers and emitting the results of this merger, while limiting the maximum number of concurrent
* subscriptions to these Publishers.
* <p>
* <!-- <p> -->
* <!-- <img width="640" height="310" src="https://raw.github.com/wiki/ReactiveX/RxJava/images/rx-operators/flatMap.png" alt=""> -->
* <dl>
* <dt><b>Backpressure:</b></dt>
Expand Down Expand Up @@ -8411,7 +8399,7 @@ public final <R> Flowable<R> flatMap(Function<? super T, ? extends Publisher<? e
* by the source Publisher, where that function returns a Publisher, and then merging those resulting
* Publishers and emitting the results of this merger, while limiting the maximum number of concurrent
* subscriptions to these Publishers.
* <p>
* <!-- <p> -->
* <!-- <img width="640" height="310" src="https://raw.github.com/wiki/ReactiveX/RxJava/images/rx-operators/flatMap.png" alt=""> -->
* <dl>
* <dt><b>Backpressure:</b></dt>
Expand Down Expand Up @@ -8505,7 +8493,7 @@ public final <R> Flowable<R> flatMap(
* Returns a Flowable that applies a function to each item emitted or notification raised by the source
* Publisher and then flattens the Publishers returned from these functions and emits the resulting items,
* while limiting the maximum number of concurrent subscriptions to these Publishers.
* <p>
* <!-- <p> -->
* <!-- <img width="640" height="410" src="https://raw.github.com/wiki/ReactiveX/RxJava/images/rx-operators/mergeMap.nce.png" alt=""> -->
* <dl>
* <dt><b>Backpressure:</b></dt>
Expand Down Expand Up @@ -8628,7 +8616,7 @@ public final <U, R> Flowable<R> flatMap(Function<? super T, ? extends Publisher<
* Returns a Flowable that emits the results of a specified function to the pair of values emitted by the
* source Publisher and a specified collection Publisher, while limiting the maximum number of concurrent
* subscriptions to these Publishers.
* <p>
* <!-- <p> -->
* <!-- <img width="640" height="390" src="https://raw.github.com/wiki/ReactiveX/RxJava/images/rx-operators/mergeMap.r.png" alt=""> -->
* <dl>
* <dt><b>Backpressure:</b></dt>
Expand Down Expand Up @@ -8671,7 +8659,7 @@ public final <U, R> Flowable<R> flatMap(Function<? super T, ? extends Publisher<
* Returns a Flowable that emits the results of a specified function to the pair of values emitted by the
* source Publisher and a specified collection Publisher, while limiting the maximum number of concurrent
* subscriptions to these Publishers.
* <p>
* <!-- <p> -->
* <!-- <img width="640" height="390" src="https://raw.github.com/wiki/ReactiveX/RxJava/images/rx-operators/mergeMap.r.png" alt=""> -->
* <dl>
* <dt><b>Backpressure:</b></dt>
Expand Down Expand Up @@ -8720,7 +8708,7 @@ public final <U, R> Flowable<R> flatMap(final Function<? super T, ? extends Publ
* Returns a Flowable that emits the results of a specified function to the pair of values emitted by the
* source Publisher and a specified collection Publisher, while limiting the maximum number of concurrent
* subscriptions to these Publishers.
* <p>
* <!-- <p> -->
* <!-- <img width="640" height="390" src="https://raw.github.com/wiki/ReactiveX/RxJava/images/rx-operators/mergeMap.r.png" alt=""> -->
* <dl>
* <dt><b>Backpressure:</b></dt>
Expand Down Expand Up @@ -10111,7 +10099,7 @@ public final Flowable<T> onBackpressureBuffer(int capacity, Action onOverflow) {
* cancelling the source, and notifying the producer with {@code onOverflow}. </li>
* <li>{@code BackpressureOverflow.Strategy.ON_OVERFLOW_DROP_LATEST} will drop any new items emitted by the producer while
* the buffer is full, without generating any {@code onError}. Each drop will however invoke {@code onOverflow}
* to signal the overflow to the producer.</li>j
* to signal the overflow to the producer.</li>
* <li>{@code BackpressureOverflow.Strategy.ON_OVERFLOW_DROP_OLDEST} will drop the oldest items in the buffer in order to make
* room for newly emitted ones. Overflow will not generate an{@code onError}, but each drop will invoke
* {@code onOverflow} to signal the overflow to the producer.</li>
Expand Down Expand Up @@ -10212,7 +10200,6 @@ public final Flowable<T> onBackpressureDrop(Consumer<? super T> onDrop) {
* <p>
* Note that due to the nature of how backpressure requests are propagated through subscribeOn/observeOn,
* requesting more than 1 from downstream doesn't guarantee a continuous delivery of onNext events.
* <p>
* <dl>
* <dt><b>Backpressure:</b></dt>
* <dd>The operator honors backpressure from downstream and consumes the source {@code Publisher} in an unbounded
Expand Down Expand Up @@ -13125,8 +13112,8 @@ public final Flowable<T> subscribeOn(@NonNull Scheduler scheduler, boolean reque
/**
* Returns a Flowable that emits the items emitted by the source Publisher or the items of an alternate
* Publisher if the source Publisher is empty.
* <p>
* <img width="640" height="255" src="https://raw.github.com/wiki/ReactiveX/RxJava/images/rx-operators/switchifempty.png" alt="">
* <p/>
* <dl>
* <dt><b>Backpressure:</b></dt>
* <dd>If the source {@code Publisher} is empty, the alternate {@code Publisher} is expected to honor backpressure.
Expand Down Expand Up @@ -13953,7 +13940,6 @@ public final Flowable<T> throttleLast(long intervalDuration, TimeUnit unit, Sche
* <img width="640" height="305" src="https://raw.github.com/wiki/ReactiveX/RxJava/images/rx-operators/throttleWithTimeout.png" alt="">
* <p>
* Information on debounce vs throttle:
* <p>
* <ul>
* <li><a href="http://drupalmotion.com/article/debounce-and-throttle-visual-explanation">Debounce and Throttle: visual explanation</a></li>
* <li><a href="http://unscriptable.com/2009/03/20/debouncing-javascript-methods/">Debouncing: javascript methods</a></li>
Expand Down Expand Up @@ -13995,7 +13981,6 @@ public final Flowable<T> throttleWithTimeout(long timeout, TimeUnit unit) {
* <img width="640" height="305" src="https://raw.github.com/wiki/ReactiveX/RxJava/images/rx-operators/throttleWithTimeout.s.png" alt="">
* <p>
* Information on debounce vs throttle:
* <p>
* <ul>
* <li><a href="http://drupalmotion.com/article/debounce-and-throttle-visual-explanation">Debounce and Throttle: visual explanation</a></li>
* <li><a href="http://unscriptable.com/2009/03/20/debouncing-javascript-methods/">Debouncing: javascript methods</a></li>
Expand Down Expand Up @@ -16064,7 +16049,6 @@ public final <U, R> Flowable<R> zipWith(Iterable<U> other, BiFunction<? super T
* Returns a Flowable that emits items that are the result of applying a specified function to pairs of
* values, one each from the source Publisher and another specified Publisher.
* <p>
* <p>
* The operator subscribes to its sources in order they are specified and completes eagerly if
* one of the sources is shorter than the rest while cancelling the other sources. Therefore, it
* is possible those other sources will never be able to run to completion (and thus not calling
Expand Down Expand Up @@ -16112,7 +16096,6 @@ public final <U, R> Flowable<R> zipWith(Publisher<? extends U> other, BiFunction
* Returns a Flowable that emits items that are the result of applying a specified function to pairs of
* values, one each from the source Publisher and another specified Publisher.
* <p>
* <p>
* The operator subscribes to its sources in order they are specified and completes eagerly if
* one of the sources is shorter than the rest while cancelling the other sources. Therefore, it
* is possible those other sources will never be able to run to completion (and thus not calling
Expand Down Expand Up @@ -16163,7 +16146,6 @@ public final <U, R> Flowable<R> zipWith(Publisher<? extends U> other,
* Returns a Flowable that emits items that are the result of applying a specified function to pairs of
* values, one each from the source Publisher and another specified Publisher.
* <p>
* <p>
* The operator subscribes to its sources in order they are specified and completes eagerly if
* one of the sources is shorter than the rest while cancelling the other sources. Therefore, it
* is possible those other sources will never be able to run to completion (and thus not calling
Expand Down
6 changes: 0 additions & 6 deletions src/main/java/io/reactivex/Maybe.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -463,7 +463,6 @@ public static <T> Flowable<T> concatEager(Publisher<? extends MaybeSource<? exte
*
* });
* </code></pre>
* <p>
* <dl>
* <dt><b>Scheduler:</b></dt>
* <dd>{@code create} does not operate by default on a particular {@link Scheduler}.</dd>
Expand Down Expand Up @@ -837,7 +836,6 @@ public static <T> Flowable<T> merge(Publisher<? extends MaybeSource<? extends T>
* emitted by the nested {@code MaybeSource}, without any transformation.
* <p>
* <img width="640" height="393" src="https://raw.github.com/wiki/ReactiveX/RxJava/images/rx-operators/Maybe.merge.oo.png" alt="">
* <p>
* <dl>
* <dt><b>Scheduler:</b></dt>
* <dd>{@code merge} does not operate by default on a particular {@link Scheduler}.</dd>
Expand Down Expand Up @@ -2271,7 +2269,6 @@ public final Maybe<T> delay(long delay, TimeUnit unit, Scheduler scheduler) {
* Delays the emission of this Maybe until the given Publisher signals an item or completes.
* <p>
* <img width="640" height="450" src="https://raw.github.com/wiki/ReactiveX/RxJava/images/rx-operators/delay.oo.png" alt="">
* <p>
* <dl>
* <dt><b>Backpressure:</b></dt>
* <dd>The {@code delayIndicator} is consumed in an unbounded manner but is cancelled after
Expand Down Expand Up @@ -2301,7 +2298,6 @@ public final <U, V> Maybe<T> delay(Publisher<U> delayIndicator) {
/**
* Returns a Maybe that delays the subscription to this Maybe
* until the other Publisher emits an element or completes normally.
* <p>
* <dl>
* <dt><b>Backpressure:</b></dt>
* <dd>The {@code Publisher} source is consumed in an unbounded fashion (without applying backpressure).</dd>
Expand Down Expand Up @@ -3803,7 +3799,6 @@ public final <E extends MaybeObserver<? super T>> E subscribeWith(E observer) {
* MaybeSource if the current Maybe is empty.
* <p>
* <img width="640" height="445" src="https://raw.github.com/wiki/ReactiveX/RxJava/images/rx-operators/switchifempty.m.png" alt="">
* <p/>
* <dl>
* <dt><b>Scheduler:</b></dt>
* <dd>{@code switchIfEmpty} does not operate by default on a particular {@link Scheduler}.</dd>
Expand All @@ -3826,7 +3821,6 @@ public final Maybe<T> switchIfEmpty(MaybeSource<? extends T> other) {
* SingleSource if the current Maybe is empty.
* <p>
* <img width="640" height="445" src="https://raw.github.com/wiki/ReactiveX/RxJava/images/rx-operators/switchifempty.m.png" alt="">
* <p/>
* <dl>
* <dt><b>Scheduler:</b></dt>
* <dd>{@code switchIfEmpty} does not operate by default on a particular {@link Scheduler}.</dd>
Expand Down
Loading

0 comments on commit 3e11dc0

Please sign in to comment.