Skip to content

Commit 19fac95

Browse files
committed
2.x: fix minor javadoc errors
1 parent b21aa20 commit 19fac95

21 files changed

+32
-26
lines changed

src/main/java/io/reactivex/internal/observers/QueueDrainObserver.java

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -83,6 +83,7 @@ protected final void fastPathEmit(U value, boolean delayError, Disposable dispos
8383
* Makes sure the fast-path emits in order.
8484
* @param value the value to emit or queue up
8585
* @param delayError if true, errors are delayed until the source has terminated
86+
* @param disposable the resource to dispose if the drain terminates
8687
*/
8788
protected final void fastPathOrderedEmit(U value, boolean delayError, Disposable disposable) {
8889
final Observer<? super V> s = actual;

src/main/java/io/reactivex/internal/operators/maybe/MaybeFlatMapCompletable.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@
2424

2525
/**
2626
* Maps the success value of the source MaybeSource into a Completable.
27-
* @param <T>
27+
* @param <T> the value type of the source MaybeSource
2828
*/
2929
public final class MaybeFlatMapCompletable<T> extends Completable {
3030

src/main/java/io/reactivex/internal/operators/single/SingleFlatMapCompletable.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@
2424

2525
/**
2626
* Maps the success value of the source SingleSource into a Completable.
27-
* @param <T>
27+
* @param <T> the value type of the source SingleSource
2828
*/
2929
public final class SingleFlatMapCompletable<T> extends Completable {
3030

src/main/java/io/reactivex/internal/queue/SpscArrayQueue.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@
3535
* 2012 - Junchang- BQueue- Efficient and Practical Queuing.pdf <br>
3636
* </i> This implementation is wait free.
3737
*
38-
* @param <E>
38+
* @param <E> the element type of the queue
3939
*/
4040
public final class SpscArrayQueue<E> extends AtomicReferenceArray<E> implements SimplePlainQueue<E> {
4141
private static final long serialVersionUID = -1296597691183856449L;

src/main/java/io/reactivex/observers/BaseTestConsumer.java

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -117,6 +117,7 @@ public final int errorCount() {
117117
* will capture those potential errors and report it along with the original failure.
118118
*
119119
* @param message the message to use
120+
* @return AssertionError the prepared AssertionError instance
120121
*/
121122
protected final AssertionError fail(String message) {
122123
StringBuilder b = new StringBuilder(64 + message.length());

src/main/java/io/reactivex/subscribers/DefaultSubscriber.java

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,7 @@ public final void onSubscribe(Subscription s) {
3737

3838
/**
3939
* Requests from the upstream Subscription.
40+
* @param n the request amount, positive
4041
*/
4142
protected final void request(long n) {
4243
Subscription s = this.s;

src/test/java/io/reactivex/flowable/FlowableEventStream.java

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -66,8 +66,9 @@ public static class Event {
6666
public final Map<String, Object> values;
6767

6868
/**
69-
* @param type
70-
* @param instanceId
69+
* Construct an event with the provided parameters.
70+
* @param type the event type
71+
* @param instanceId the instance identifier
7172
* @param values
7273
* This does NOT deep-copy, so do not mutate this Map after passing it in.
7374
*/

src/test/java/io/reactivex/flowable/FlowableTests.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -699,7 +699,7 @@ public void testErrorThrownWithoutErrorHandlerSynchronous() {
699699
* to rethrow the exception on the thread that the message comes out from the Observable.
700700
* The OnCompleted behavior in this case is to do nothing."
701701
*
702-
* @throws InterruptedException
702+
* @throws InterruptedException if the await is interrupted
703703
*/
704704
@Test
705705
@Ignore("Subscribers can't throw")

src/test/java/io/reactivex/internal/operators/flowable/BlockingFlowableNextTest.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -224,7 +224,7 @@ public void testNextWithCallingHasNextMultipleTimes() {
224224
* <p/>
225225
* This results in output such as => a: 1 b: 2 c: 89
226226
*
227-
* @throws Throwable
227+
* @throws Throwable some method call is declared throws
228228
*/
229229
@Test
230230
public void testNoBufferingOrBlockingOfSequence() throws Throwable {

src/test/java/io/reactivex/internal/operators/flowable/FlowableGroupByTest.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -171,7 +171,7 @@ public void accept(V v) {
171171
/**
172172
* Assert that only a single subscription to a stream occurs and that all events are received.
173173
*
174-
* @throws Throwable
174+
* @throws Throwable some method call is declared throws
175175
*/
176176
@Test
177177
public void testGroupedEventStream() throws Throwable {

0 commit comments

Comments
 (0)