From c0a91b88faa73fde11ba9cde62818d19c7acbf43 Mon Sep 17 00:00:00 2001 From: c-nasser Date: Wed, 27 Nov 2019 16:10:16 +0100 Subject: [PATCH] Add javadoc on ActionDisposable, correction of dangling javadoc comments and remove of unnecessary '@see'. --- src/main/java/io/reactivex/rxjava3/core/Flowable.java | 4 ---- src/main/java/io/reactivex/rxjava3/core/Maybe.java | 2 -- src/main/java/io/reactivex/rxjava3/core/Observable.java | 3 --- src/main/java/io/reactivex/rxjava3/core/Single.java | 1 - .../io/reactivex/rxjava3/disposables/ActionDisposable.java | 3 +++ .../operators/flowable/BlockingFlowableMostRecent.java | 6 ++---- .../operators/observable/BlockingObservableMostRecent.java | 6 ++---- 7 files changed, 7 insertions(+), 18 deletions(-) diff --git a/src/main/java/io/reactivex/rxjava3/core/Flowable.java b/src/main/java/io/reactivex/rxjava3/core/Flowable.java index 5639c5c7f5..f0a948f7b8 100644 --- a/src/main/java/io/reactivex/rxjava3/core/Flowable.java +++ b/src/main/java/io/reactivex/rxjava3/core/Flowable.java @@ -8134,7 +8134,6 @@ public final Single contains(final Object item) { * @return a Single that emits a single item: the number of items emitted by the source Publisher as a * 64-bit Long item * @see ReactiveX operators documentation: Count - * @see #count() */ @CheckReturnValue @BackpressureSupport(BackpressureKind.UNBOUNDED_IN) @@ -15102,7 +15101,6 @@ public final Completable switchMapCompletable(@NonNull Function Flowable switchMap0(Function> * return a {@code MaybeSource} to replace the current active inner source * and get subscribed to. * @return the new Flowable instance - * @see #switchMapMaybe(Function) * @since 2.2 */ @CheckReturnValue @@ -15301,7 +15298,6 @@ public final Flowable switchMapMaybeDelayError(@NonNull Function contains(final Object item) { * @return a Single that emits a single item: the number of items emitted by the source Maybe as a * 64-bit Long item * @see ReactiveX operators documentation: Count - * @see #count() */ @CheckReturnValue @SchedulerSupport(SchedulerSupport.NONE) @@ -2940,7 +2939,6 @@ public final Maybe doOnSubscribe(Consumer onSubscribe) { * @param onTerminate the action to invoke when the consumer calls {@code onComplete} or {@code onError} * @return the new Maybe instance * @see ReactiveX operators documentation: Do - * @see #doOnTerminate(Action) * @since 3.0.0 */ @CheckReturnValue diff --git a/src/main/java/io/reactivex/rxjava3/core/Observable.java b/src/main/java/io/reactivex/rxjava3/core/Observable.java index 601f0d2380..846ef897d9 100644 --- a/src/main/java/io/reactivex/rxjava3/core/Observable.java +++ b/src/main/java/io/reactivex/rxjava3/core/Observable.java @@ -7191,7 +7191,6 @@ public final Single contains(final Object element) { * @return a Single that emits a single item: the number of items emitted by the source ObservableSource as a * 64-bit Long item * @see ReactiveX operators documentation: Count - * @see #count() */ @CheckReturnValue @SchedulerSupport(SchedulerSupport.NONE) @@ -12476,7 +12475,6 @@ public final Completable switchMapCompletable(@NonNull Function doOnSubscribe(final Consumer onSubscr * @param onTerminate the action to invoke when the consumer calls {@code onSuccess} or {@code onError} * @return the new Single instance * @see ReactiveX operators documentation: Do - * @see #doOnTerminate(Action) * @since 3.0.0 */ @CheckReturnValue diff --git a/src/main/java/io/reactivex/rxjava3/disposables/ActionDisposable.java b/src/main/java/io/reactivex/rxjava3/disposables/ActionDisposable.java index b166862ff9..dd74d600c6 100644 --- a/src/main/java/io/reactivex/rxjava3/disposables/ActionDisposable.java +++ b/src/main/java/io/reactivex/rxjava3/disposables/ActionDisposable.java @@ -16,6 +16,9 @@ import io.reactivex.rxjava3.functions.Action; import io.reactivex.rxjava3.internal.util.ExceptionHelper; +/** + * A Disposable container that manages an Action instance. + */ final class ActionDisposable extends ReferenceDisposable { private static final long serialVersionUID = -8219729196779211169L; diff --git a/src/main/java/io/reactivex/rxjava3/internal/operators/flowable/BlockingFlowableMostRecent.java b/src/main/java/io/reactivex/rxjava3/internal/operators/flowable/BlockingFlowableMostRecent.java index 646ec7f2ab..905c1e89e7 100644 --- a/src/main/java/io/reactivex/rxjava3/internal/operators/flowable/BlockingFlowableMostRecent.java +++ b/src/main/java/io/reactivex/rxjava3/internal/operators/flowable/BlockingFlowableMostRecent.java @@ -42,10 +42,8 @@ public BlockingFlowableMostRecent(Flowable source, T initialValue) { public Iterator iterator() { MostRecentSubscriber mostRecentSubscriber = new MostRecentSubscriber(initialValue); - /** - * Subscribe instead of unsafeSubscribe since this is the final subscribe in the chain - * since it is for BlockingObservable. - */ + // Subscribe instead of unsafeSubscribe since this is the final subscribe in the chain + // since it is for BlockingObservable. source.subscribe(mostRecentSubscriber); return mostRecentSubscriber.getIterable(); diff --git a/src/main/java/io/reactivex/rxjava3/internal/operators/observable/BlockingObservableMostRecent.java b/src/main/java/io/reactivex/rxjava3/internal/operators/observable/BlockingObservableMostRecent.java index 246c4e327f..809a16d442 100644 --- a/src/main/java/io/reactivex/rxjava3/internal/operators/observable/BlockingObservableMostRecent.java +++ b/src/main/java/io/reactivex/rxjava3/internal/operators/observable/BlockingObservableMostRecent.java @@ -42,10 +42,8 @@ public BlockingObservableMostRecent(ObservableSource source, T initialValue) public Iterator iterator() { MostRecentObserver mostRecentObserver = new MostRecentObserver(initialValue); - /** - * Subscribe instead of unsafeSubscribe since this is the final subscribe in the chain - * since it is for BlockingObservable. - */ + // Subscribe instead of unsafeSubscribe since this is the final subscribe in the chain + // since it is for BlockingObservable. source.subscribe(mostRecentObserver); return mostRecentObserver.getIterable();