Skip to content

Commit 2ebacf0

Browse files
committed
javadoc enhancements for recent groupBy/compose/Transformer changes
1 parent 62ce4ac commit 2ebacf0

File tree

1 file changed

+10
-4
lines changed

1 file changed

+10
-4
lines changed

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

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -184,20 +184,25 @@ public void call(Subscriber<? super R> o) {
184184
/**
185185
* Compose Observables together with a function.
186186
*
187-
* This works on the Observables themselves whereas `lift` works on the internal Subscriber/Observers.
187+
* This works on the Observables themselves whereas {@link #lift} works on the internal
188+
* Subscriber/Observers.
188189
*
189-
* Lift should be used when creating an operator that acts on the underlying data.
190-
* Compose should be used when acting on the observable itself, such as composing multiple operators.
190+
* Use {@code lift} if you are creating an operator that acts on the underlying data. Use {@code compose} if
191+
* you are acting on the observable itself, for instance by composing multiple operators.
191192
*
193+
* @warn param transformer not described
192194
* @param transformer
193195
* @return
196+
* @since 0.20
194197
*/
195198
public <R> Observable<R> compose(Transformer<T, R> transformer) {
196199
return transformer.call(this);
197200
}
198201

199202
/**
200-
* Transformer function for `compose`
203+
* Transformer function used by {@link #compose}.
204+
* @warn more complete description needed
205+
* @since 0.20
201206
*/
202207
public static interface Transformer<T, R> extends Func1<Observable<T>, Observable<R>> {
203208
// cover for generics insanity
@@ -4989,6 +4994,7 @@ public final void forEach(final Action1<? super T> onNext, final Action1<Throwab
49894994
* key value
49904995
* @see <a href="https://github.com/Netflix/RxJava/wiki/Transforming-Observables#groupby-and-groupbyuntil">RxJava wiki: groupBy</a>
49914996
* @see <a href="http://msdn.microsoft.com/en-us/library/system.reactive.linq.observable.groupby.aspx">MSDN: Observable.GroupBy</a>
4997+
* @since 0.20
49924998
*/
49934999
public final <K, R> Observable<GroupedObservable<K, R>> groupBy(final Func1<? super T, ? extends K> keySelector, final Func1<? super T, ? extends R> elementSelector) {
49945000
return lift(new OperatorGroupBy<T, K, R>(keySelector, elementSelector));

0 commit comments

Comments
 (0)