Skip to content

Commit 8b67bbf

Browse files
committed
Fix docs and validation errors
1 parent 68e2109 commit 8b67bbf

File tree

10 files changed

+16
-16
lines changed

10 files changed

+16
-16
lines changed

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -914,7 +914,7 @@ public final Completable andThen(CompletableSource next) {
914914
* This allows fluent conversion to any other type.
915915
* <dl>
916916
* <dt><b>Scheduler:</b></dt>
917-
* <dd>{@code to} does not operate by default on a particular {@link Scheduler}.</dd>
917+
* <dd>{@code as} does not operate by default on a particular {@link Scheduler}.</dd>
918918
* </dl>
919919
*
920920
* @param <R> the resulting object type
@@ -925,7 +925,7 @@ public final Completable andThen(CompletableSource next) {
925925
@Experimental
926926
@CheckReturnValue
927927
@SchedulerSupport(SchedulerSupport.NONE)
928-
public final <R> R as(CompletableConverter<? extends R> converter) {
928+
public final <R> R as(@NonNull CompletableConverter<? extends R> converter) {
929929
try {
930930
return ObjectHelper.requireNonNull(converter, "converter is null").apply(this);
931931
} catch (Throwable ex) {

src/main/java/io/reactivex/CompletableConverter.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@
2424
@Experimental
2525
public interface CompletableConverter<R> {
2626
/**
27-
* Applies a function to the upstream Completable and returns a converted value of type <R>.
27+
* Applies a function to the upstream Completable and returns a converted value of type {@code R}.
2828
*
2929
* @param upstream the upstream Completable instance
3030
* @return the converted value

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5245,7 +5245,7 @@ public final Single<Boolean> any(Predicate<? super T> predicate) {
52455245
* <dt><b>Backpressure:</b></dt>
52465246
* <dd>The backpressure behavior depends on what happens in the {@code converter} function.</dd>
52475247
* <dt><b>Scheduler:</b></dt>
5248-
* <dd>{@code to} does not operate by default on a particular {@link Scheduler}.</dd>
5248+
* <dd>{@code as} does not operate by default on a particular {@link Scheduler}.</dd>
52495249
* </dl>
52505250
*
52515251
* @param <R> the resulting object type
@@ -5257,7 +5257,7 @@ public final Single<Boolean> any(Predicate<? super T> predicate) {
52575257
@CheckReturnValue
52585258
@BackpressureSupport(BackpressureKind.SPECIAL)
52595259
@SchedulerSupport(SchedulerSupport.NONE)
5260-
public final <R> R as(FlowableConverter<T, ? extends R> converter) {
5260+
public final <R> R as(@NonNull FlowableConverter<T, ? extends R> converter) {
52615261
try {
52625262
return ObjectHelper.requireNonNull(converter, "converter is null").apply(this);
52635263
} catch (Throwable ex) {

src/main/java/io/reactivex/FlowableConverter.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@
2525
@Experimental
2626
public interface FlowableConverter<T, R> {
2727
/**
28-
* Applies a function to the upstream Flowable and returns a converted value of type <R>.
28+
* Applies a function to the upstream Flowable and returns a converted value of type {@code R}.
2929
*
3030
* @param upstream the upstream Flowable instance
3131
* @return the converted value

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1995,7 +1995,7 @@ public final Maybe<T> ambWith(MaybeSource<? extends T> other) {
19951995
* This allows fluent conversion to any other type.
19961996
* <dl>
19971997
* <dt><b>Scheduler:</b></dt>
1998-
* <dd>{@code to} does not operate by default on a particular {@link Scheduler}.</dd>
1998+
* <dd>{@code as} does not operate by default on a particular {@link Scheduler}.</dd>
19991999
* </dl>
20002000
*
20012001
* @param <R> the resulting object type
@@ -2006,7 +2006,7 @@ public final Maybe<T> ambWith(MaybeSource<? extends T> other) {
20062006
@Experimental
20072007
@CheckReturnValue
20082008
@SchedulerSupport(SchedulerSupport.NONE)
2009-
public final <R> R as(MaybeConverter<T, ? extends R> converter) {
2009+
public final <R> R as(@NonNull MaybeConverter<T, ? extends R> converter) {
20102010
try {
20112011
return ObjectHelper.requireNonNull(converter, "converter is null").apply(this);
20122012
} catch (Throwable ex) {

src/main/java/io/reactivex/MaybeConverter.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@
2525
@Experimental
2626
public interface MaybeConverter<T, R> {
2727
/**
28-
* Applies a function to the upstream Maybe and returns a converted value of type <R>.
28+
* Applies a function to the upstream Maybe and returns a converted value of type {@code R}.
2929
*
3030
* @param upstream the upstream Maybe instance
3131
* @return the converted value

src/main/java/io/reactivex/Observable.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4806,7 +4806,7 @@ public final Single<Boolean> any(Predicate<? super T> predicate) {
48064806
* This allows fluent conversion to any other type.
48074807
* <dl>
48084808
* <dt><b>Scheduler:</b></dt>
4809-
* <dd>{@code to} does not operate by default on a particular {@link Scheduler}.</dd>
4809+
* <dd>{@code as} does not operate by default on a particular {@link Scheduler}.</dd>
48104810
* </dl>
48114811
*
48124812
* @param <R> the resulting object type
@@ -4817,7 +4817,7 @@ public final Single<Boolean> any(Predicate<? super T> predicate) {
48174817
@Experimental
48184818
@CheckReturnValue
48194819
@SchedulerSupport(SchedulerSupport.NONE)
4820-
public final <R> R as(ObservableConverter<T, ? extends R> converter) {
4820+
public final <R> R as(@NonNull ObservableConverter<T, ? extends R> converter) {
48214821
try {
48224822
return ObjectHelper.requireNonNull(converter, "converter is null").apply(this);
48234823
} catch (Throwable ex) {

src/main/java/io/reactivex/ObservableConverter.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@
2525
@Experimental
2626
public interface ObservableConverter<T, R> {
2727
/**
28-
* Applies a function to the upstream Observable and returns a converted value of type <R>.
28+
* Applies a function to the upstream Observable and returns a converted value of type {@code R}.
2929
*
3030
* @param upstream the upstream Observable instance
3131
* @return the converted value

src/main/java/io/reactivex/Single.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1528,7 +1528,7 @@ public final Single<T> ambWith(SingleSource<? extends T> other) {
15281528
* This allows fluent conversion to any other type.
15291529
* <dl>
15301530
* <dt><b>Scheduler:</b></dt>
1531-
* <dd>{@code to} does not operate by default on a particular {@link Scheduler}.</dd>
1531+
* <dd>{@code as} does not operate by default on a particular {@link Scheduler}.</dd>
15321532
* </dl>
15331533
*
15341534
* @param <R> the resulting object type
@@ -1539,7 +1539,7 @@ public final Single<T> ambWith(SingleSource<? extends T> other) {
15391539
@Experimental
15401540
@CheckReturnValue
15411541
@SchedulerSupport(SchedulerSupport.NONE)
1542-
public final <R> R as(SingleConverter<T, ? extends R> converter) {
1542+
public final <R> R as(@NonNull SingleConverter<T, ? extends R> converter) {
15431543
try {
15441544
return ObjectHelper.requireNonNull(converter, "converter is null").apply(this);
15451545
} catch (Throwable ex) {

src/main/java/io/reactivex/SingleConverter.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
import io.reactivex.annotations.*;
1717

1818
/**
19-
* Convenience interface and callback used by the {@link Single#as} operator to turn an Single into another
19+
* Convenience interface and callback used by the {@link Single#as} operator to turn a Single into another
2020
* value fluently.
2121
*
2222
* @param <T> the upstream type
@@ -25,7 +25,7 @@
2525
@Experimental
2626
public interface SingleConverter<T, R> {
2727
/**
28-
* Applies a function to the upstream Single and returns a converted value of type <R>.
28+
* Applies a function to the upstream Single and returns a converted value of type {@code R}.
2929
*
3030
* @param upstream the upstream Single instance
3131
* @return the converted value

0 commit comments

Comments
 (0)