Skip to content

Commit 19f3b79

Browse files
committed
minor javadoc improvements
1 parent 62de4d0 commit 19f3b79

File tree

2 files changed

+19
-20
lines changed

2 files changed

+19
-20
lines changed

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

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -2398,7 +2398,7 @@ public final static <T> Observable<Observable<T>> parallelMerge(Observable<Obser
23982398
* and and the set on which their items are grouped.
23992399
* <p>
24002400
* <img width="640" height="580" src="https://raw.github.com/wiki/Netflix/RxJava/images/rx-operators/pivot.png" alt="">
2401-
*
2401+
* <p>
24022402
* For example an {@code Observable} such as this =&gt;
24032403
*
24042404
* {@code Observable<GroupedObservable<String, GroupedObservable<Boolean, Integer>>>}:
@@ -6013,7 +6013,7 @@ public final Observable<T> serialize() {
60136013

60146014
/**
60156015
* Returns a new {@link Observable} that multicasts (shares) the original {@link Observable}. As long as
6016-
* there is more than 1 {@link Subscriber} this {@link Observable} will be subscribed and emitting data.
6016+
* there is more than one {@link Subscriber} this {@link Observable} will be subscribed and emitting data.
60176017
* When all subscribers have unsubscribed it will unsubscribe from the source {@link Observable}.
60186018
* <p>
60196019
* This is an alias for {@link #publish()}.{@link ConnectableObservable#refCount()}.
@@ -6022,7 +6022,7 @@ public final Observable<T> serialize() {
60226022
* <p>
60236023
* {@code share} does not operate by default on a particular {@link Scheduler}.
60246024
*
6025-
* @return a {@link Observable} that upon connection causes the source Observable to emit items
6025+
* @return an {@code Observable} that upon connection causes the source {@code Observable} to emit items
60266026
* to its {@link Observer}s
60276027
* @see <a href="https://github.com/Netflix/RxJava/wiki/Connectable-Observable-Operators#connectableobservablerefcount">RxJava Wiki: refCount()</a>
60286028
* @since 0.19
@@ -7528,9 +7528,9 @@ public final Observable<TimeInterval<T>> timeInterval(Scheduler scheduler) {
75287528
}
75297529

75307530
/**
7531-
* Returns an Observable that mirrors the source Observable, but notifies observers of a TimeoutException if
7532-
* either the first item emitted by the source Observable or any subsequent item don't arrive within time
7533-
* windows defined by other Observables.
7531+
* Returns an Observable that mirrors the source Observable, but notifies observers of a
7532+
* {@code TimeoutException} if either the first item emitted by the source Observable or any subsequent item
7533+
* doesn't arrive within time windows defined by other Observables.
75347534
* <p>
75357535
* <img width="640" height="400" src="https://raw.github.com/wiki/Netflix/RxJava/images/rx-operators/timeout5.png" alt="">
75367536
* <p>
@@ -7547,17 +7547,17 @@ public final Observable<TimeInterval<T>> timeInterval(Scheduler scheduler) {
75477547
* a function that returns an Observable for each item emitted by the source Observable and that
75487548
* determines the timeout window in which the subsequent source item must arrive in order to
75497549
* continue the sequence
7550-
* @return an Observable that mirrors the source Observable, but notifies observers of a TimeoutException if
7551-
* either the first item or any subsequent item doesn't arrive within the time windows specified by
7552-
* the timeout selectors
7550+
* @return an Observable that mirrors the source Observable, but notifies observers of a
7551+
* {@code TimeoutException} if either the first item or any subsequent item doesn't arrive within
7552+
* the time windows specified by the timeout selectors
75537553
*/
75547554
public final <U, V> Observable<T> timeout(Func0<? extends Observable<U>> firstTimeoutSelector, Func1<? super T, ? extends Observable<V>> timeoutSelector) {
75557555
return timeout(firstTimeoutSelector, timeoutSelector, null);
75567556
}
75577557

75587558
/**
75597559
* Returns an Observable that mirrors the source Observable, but switches to a fallback Observable if either
7560-
* the first item emitted by the source Observable or any subsequent item don't arrive within time windows
7560+
* the first item emitted by the source Observable or any subsequent item doesn't arrive within time windows
75617561
* defined by other Observables.
75627562
* <p>
75637563
* <img width="640" height="400" src="https://raw.github.com/wiki/Netflix/RxJava/images/rx-operators/timeout6.png" alt="">
@@ -7578,8 +7578,8 @@ public final <U, V> Observable<T> timeout(Func0<? extends Observable<U>> firstTi
75787578
* @param other
75797579
* the fallback Observable to switch to if the source Observable times out
75807580
* @return an Observable that mirrors the source Observable, but switches to the {@code other} Observable if
7581-
* either the first item emitted by the source Observable or any subsequent item don't arrive within
7582-
* time windows defined by the timeout selectors
7581+
* either the first item emitted by the source Observable or any subsequent item doesn't arrive
7582+
* within time windows defined by the timeout selectors
75837583
* @throws NullPointerException
75847584
* if {@code timeoutSelector} is null
75857585
*/
@@ -7591,10 +7591,10 @@ public final <U, V> Observable<T> timeout(Func0<? extends Observable<U>> firstTi
75917591
}
75927592

75937593
/**
7594-
* Returns an Observable that mirrors the source Observable, but notifies observers of a TimeoutException if
7595-
* an item emitted by the source Observable doesn't arrive within a window of time after the emission of the
7596-
* previous item, where that period of time is measured by an Observable that is a function of the previous
7597-
* item.
7594+
* Returns an Observable that mirrors the source Observable, but notifies observers of a
7595+
* {@code TimeoutException} if an item emitted by the source Observable doesn't arrive within a window of
7596+
* time after the emission of the previous item, where that period of time is measured by an Observable that
7597+
* is a function of the previous item.
75987598
* <p>
75997599
* <img width="640" height="400" src="https://raw.github.com/wiki/Netflix/RxJava/images/rx-operators/timeout3.png" alt="">
76007600
* <p>
@@ -7607,9 +7607,9 @@ public final <U, V> Observable<T> timeout(Func0<? extends Observable<U>> firstTi
76077607
* @param timeoutSelector
76087608
* a function that returns an observable for each item emitted by the source
76097609
* Observable and that determines the timeout window for the subsequent item
7610-
* @return an Observable that mirrors the source Observable, but notifies observers of a TimeoutException if
7611-
* an item emitted by the source Observable takes longer to arrive than the time window defined by
7612-
* the selector for the previously emitted item
7610+
* @return an Observable that mirrors the source Observable, but notifies observers of a
7611+
* {@code TimeoutException} if an item emitted by the source Observable takes longer to arrive than
7612+
* the time window defined by the selector for the previously emitted item
76137613
*/
76147614
public final <V> Observable<T> timeout(Func1<? super T, ? extends Observable<V>> timeoutSelector) {
76157615
return timeout(null, timeoutSelector, null);

rxjava-core/src/main/java/rx/observables/GroupedObservable.java

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,6 @@
3434
* the type of the items emitted by the {@code GroupedObservable}
3535
* @see Observable#groupBy(Func1)
3636
* @see <a href="https://github.com/Netflix/RxJava/wiki/Transforming-Observables#groupby-and-groupbyuntil">RxJava Wiki: groupBy() and groupByUntil()</a>
37-
* @see <a href="https://github.com/Netflix/RxJava/wiki/Transforming-Observables#pivot">RxJava Wiki: pivot()</a>
3837
*/
3938
public class GroupedObservable<K, T> extends Observable<T> {
4039
private final K key;

0 commit comments

Comments
 (0)