Skip to content

Commit 91888b3

Browse files
akarnokdakarnokd
committed
1.x: javac- and javadoc-related cleanup in components, part 1 (ReactiveX#3949)
1 parent edc4d50 commit 91888b3

File tree

91 files changed

+532
-89
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

91 files changed

+532
-89
lines changed

‎src/main/java/rx/BackpressureOverflow.java‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -37,11 +37,11 @@ public interface Strategy {
3737
}
3838

3939
public static final BackpressureOverflow.Strategy ON_OVERFLOW_DEFAULT = Error.INSTANCE;
40-
@SuppressWarnings("unused")
40+
4141
public static final BackpressureOverflow.Strategy ON_OVERFLOW_ERROR = Error.INSTANCE;
42-
@SuppressWarnings("unused")
42+
4343
public static final BackpressureOverflow.Strategy ON_OVERFLOW_DROP_OLDEST = DropOldest.INSTANCE;
44-
@SuppressWarnings("unused")
44+
4545
public static final BackpressureOverflow.Strategy ON_OVERFLOW_DROP_LATEST = DropLatest.INSTANCE;
4646

4747
/**

‎src/main/java/rx/Observable.java‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -116,6 +116,7 @@ public static <T> Observable<T> create(OnSubscribe<T> f) {
116116
*
117117
* @param <T>
118118
* the type of the items that this Observable emits
119+
* @param <S> the state type
119120
* @param syncOnSubscribe
120121
* an implementation of {@link SyncOnSubscribe}. There are many static creation methods
121122
* on the class for convenience.
@@ -151,6 +152,7 @@ public static <S, T> Observable<T> create(SyncOnSubscribe<S, T> syncOnSubscribe)
151152
*
152153
* @param <T>
153154
* the type of the items that this Observable emits
155+
* @param <S> the state type
154156
* @param asyncOnSubscribe
155157
* an implementation of {@link AsyncOnSubscribe}. There are many static creation methods
156158
* on the class for convenience.
@@ -167,13 +169,16 @@ public static <S, T> Observable<T> create(AsyncOnSubscribe<S, T> asyncOnSubscrib
167169

168170
/**
169171
* Invoked when Observable.subscribe is called.
172+
* @param <T> the output value type
170173
*/
171174
public interface OnSubscribe<T> extends Action1<Subscriber<? super T>> {
172175
// cover for generics insanity
173176
}
174177

175178
/**
176179
* Operator function for lifting into an Observable.
180+
* @param <T> the upstream's value type (input)
181+
* @param <R> the downstream's value type (output)
177182
*/
178183
public interface Operator<R, T> extends Func1<Subscriber<? super R>, Subscriber<? super T>> {
179184
// cover for generics insanity

‎src/main/java/rx/Single.java‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -135,6 +135,7 @@ public static <T> Single<T> create(OnSubscribe<T> f) {
135135

136136
/**
137137
* Invoked when Single.execute is called.
138+
* @param <T> the output value type
138139
*/
139140
public interface OnSubscribe<T> extends Action1<SingleSubscriber<? super T>> {
140141
// cover for generics insanity
@@ -157,6 +158,7 @@ public interface OnSubscribe<T> extends Action1<SingleSubscriber<? super T>> {
157158
* <dd>{@code lift} does not operate by default on a particular {@link Scheduler}.</dd>
158159
* </dl>
159160
*
161+
* @param <R> the downstream's value type (output)
160162
* @param lift
161163
* the Operator that implements the Single-operating function to be applied to the source Single
162164
* @return a Single that is the result of applying the lifted Operator to the source Single
@@ -657,12 +659,14 @@ public static <T> Single<T> just(final T value) {
657659
* <dd>{@code merge} does not operate by default on a particular {@link Scheduler}.</dd>
658660
* </dl>
659661
*
662+
* @param <T> the value type of the sources and the output
660663
* @param source
661664
* a {@code Single} that emits a {@code Single}
662665
* @return a {@code Single} that emits the item that is the result of flattening the {@code Single} emitted
663666
* by {@code source}
664667
* @see <a href="http://reactivex.io/documentation/operators/merge.html">ReactiveX operators documentation: Merge</a>
665668
*/
669+
@SuppressWarnings({ "unchecked", "rawtypes" })
666670
public static <T> Single<T> merge(final Single<? extends Single<? extends T>> source) {
667671
if (source instanceof ScalarSynchronousSingle) {
668672
return ((ScalarSynchronousSingle<T>) source).scalarFlatMap((Func1) UtilityFunctions.identity());

‎src/main/java/rx/exceptions/CompositeException.java‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,11 @@ public final class CompositeException extends RuntimeException {
4141
private final List<Throwable> exceptions;
4242
private final String message;
4343

44-
/** @deprecated please use {@link #CompositeException(Collection)} */
44+
/**
45+
* Constructs a CompositeException with the given prefix and error collection.
46+
* @param messagePrefix the prefix to use (actually unused)
47+
* @param errors the collection of errors
48+
* @deprecated please use {@link #CompositeException(Collection)} */
4549
@Deprecated
4650
public CompositeException(String messagePrefix, Collection<? extends Throwable> errors) {
4751
Set<Throwable> deDupedExceptions = new LinkedHashSet<Throwable>();

‎src/main/java/rx/exceptions/OnCompletedFailedException.java‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ public final class OnCompletedFailedException extends RuntimeException {
2727
/**
2828
* Wraps the {@code Throwable} before it is to be re-thrown as an {@code OnCompletedFailedException}.
2929
*
30-
* @param e
30+
* @param throwable
3131
* the {@code Throwable} to re-throw; if null, a NullPointerException is constructed
3232
*/
3333
public OnCompletedFailedException(Throwable throwable) {
@@ -40,7 +40,7 @@ public OnCompletedFailedException(Throwable throwable) {
4040
*
4141
* @param message
4242
* the message to assign to the {@code Throwable} to re-throw
43-
* @param e
43+
* @param throwable
4444
* the {@code Throwable} to re-throw; if null, a NullPointerException is constructed
4545
*/
4646
public OnCompletedFailedException(String message, Throwable throwable) {

‎src/main/java/rx/functions/Action1.java‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@
1717

1818
/**
1919
* A one-argument action.
20+
* @param <T> the first argument type
2021
*/
2122
public interface Action1<T> extends Action {
2223
void call(T t);

‎src/main/java/rx/functions/Action2.java‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,8 @@
1717

1818
/**
1919
* A two-argument action.
20+
* @param <T1> the first argument type
21+
* @param <T2> the second argument type
2022
*/
2123
public interface Action2<T1, T2> extends Action {
2224
void call(T1 t1, T2 t2);

‎src/main/java/rx/functions/Action3.java‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,9 @@
1717

1818
/**
1919
* A three-argument action.
20+
* @param <T1> the first argument type
21+
* @param <T2> the second argument type
22+
* @param <T3> the third argument type
2023
*/
2124
public interface Action3<T1, T2, T3> extends Action {
2225
void call(T1 t1, T2 t2, T3 t3);

‎src/main/java/rx/functions/Action4.java‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,10 @@
1818

1919
/**
2020
* A four-argument action.
21+
* @param <T1> the first argument type
22+
* @param <T2> the second argument type
23+
* @param <T3> the third argument type
24+
* @param <T4> the fourth argument type
2125
*/
2226
public interface Action4<T1, T2, T3, T4> extends Action {
2327
void call(T1 t1, T2 t2, T3 t3, T4 t4);

‎src/main/java/rx/functions/Action5.java‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,11 @@
1818

1919
/**
2020
* A five-argument action.
21+
* @param <T1> the first argument type
22+
* @param <T2> the second argument type
23+
* @param <T3> the third argument type
24+
* @param <T4> the fourth argument type
25+
* @param <T5> the fifth argument type
2126
*/
2227
public interface Action5<T1, T2, T3, T4, T5> extends Action {
2328
void call(T1 t1, T2 t2, T3 t3, T4 t4, T5 t5);

0 commit comments

Comments
 (0)