Skip to content

Commit 52cef14

Browse files
Confusing Javadoc for toObservable(Future) methods
#148
1 parent c241462 commit 52cef14

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

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

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1976,7 +1976,8 @@ public static <T> Observable<T> toObservable(Iterable<T> iterable) {
19761976
*
19771977
* Any object that supports the {@link Future} interface can be converted into an Observable that emits
19781978
* the return value of the get() method in the object, by passing the object into the <code>toObservable</code> method.
1979-
* The subscribe method on this synchronously so the Subscription returned doesn't nothing.
1979+
* <p>
1980+
* This is blocking so the Subscription returned when calling {@link #subscribe(Observer)} does nothing.
19801981
*
19811982
* @param future
19821983
* the source {@link Future}
@@ -1995,7 +1996,8 @@ public static <T> Observable<T> toObservable(Future<T> future) {
19951996
* Any object that supports the {@link Future} interface can be converted into an Observable that emits
19961997
* the return value of the get() method in the object, by passing the object into the <code>toObservable</code> method.
19971998
* The subscribe method on this synchronously so the Subscription returned doesn't nothing.
1998-
* If the future timesout the {@link TimeoutException} exception is passed to the onError.
1999+
* <p>
2000+
* This is blocking so the Subscription returned when calling {@link #subscribe(Observer)} does nothing.
19992001
*
20002002
* @param future
20012003
* the source {@link Future}

0 commit comments

Comments
 (0)