Skip to content

2.x: improve JavaDocs of the subscribeActual methods #5981

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 29, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion src/main/java/io/reactivex/Completable.java
Original file line number Diff line number Diff line change
Expand Up @@ -1927,8 +1927,11 @@ public final void subscribe(CompletableObserver s) {
}

/**
* Implement this to handle the incoming CompletableObserver and
* Implement this method to handle the incoming {@link CompletableObserver}s and
* perform the business logic in your operator.
* <p>There is no need to call any of the plugin hooks on the current {@code Completable} instance or
* the {@code CompletableObserver}; all hooks and basic safeguards have been
* applied by {@link #subscribe(CompletableObserver)} before this method gets called.
* @param s the CompletableObserver instance, never null
*/
protected abstract void subscribeActual(CompletableObserver s);
Expand Down
7 changes: 4 additions & 3 deletions src/main/java/io/reactivex/Flowable.java
Original file line number Diff line number Diff line change
Expand Up @@ -14333,9 +14333,10 @@ public final void subscribe(FlowableSubscriber<? super T> s) {

/**
* Operator implementations (both source and intermediate) should implement this method that
* performs the necessary business logic.
* <p>There is no need to call any of the plugin hooks on the current Flowable instance or
* the Subscriber.
* performs the necessary business logic and handles the incoming {@link Subscriber}s.
* <p>There is no need to call any of the plugin hooks on the current {@code Flowable} instance or
* the {@code Subscriber}; all hooks and basic safeguards have been
* applied by {@link #subscribe(Subscriber)} before this method gets called.
* @param s the incoming Subscriber, never null
*/
protected abstract void subscribeActual(Subscriber<? super T> s);
Expand Down
5 changes: 4 additions & 1 deletion src/main/java/io/reactivex/Maybe.java
Original file line number Diff line number Diff line change
Expand Up @@ -4082,7 +4082,10 @@ public final void subscribe(MaybeObserver<? super T> observer) {
}

/**
* Override this method in subclasses to handle the incoming MaybeObservers.
* Implement this method in subclasses to handle the incoming {@link MaybeObserver}s.
* <p>There is no need to call any of the plugin hooks on the current {@code Maybe} instance or
* the {@code MaybeObserver}; all hooks and basic safeguards have been
* applied by {@link #subscribe(MaybeObserver)} before this method gets called.
* @param observer the MaybeObserver to handle, not null
*/
protected abstract void subscribeActual(MaybeObserver<? super T> observer);
Expand Down
7 changes: 4 additions & 3 deletions src/main/java/io/reactivex/Observable.java
Original file line number Diff line number Diff line change
Expand Up @@ -12039,9 +12039,10 @@ public final void subscribe(Observer<? super T> observer) {

/**
* Operator implementations (both source and intermediate) should implement this method that
* performs the necessary business logic.
* <p>There is no need to call any of the plugin hooks on the current Observable instance or
* the Subscriber.
* performs the necessary business logic and handles the incoming {@link Observer}s.
* <p>There is no need to call any of the plugin hooks on the current {@code Observable} instance or
* the {@code Observer}; all hooks and basic safeguards have been
* applied by {@link #subscribe(Observer)} before this method gets called.
* @param observer the incoming Observer, never null
*/
protected abstract void subscribeActual(Observer<? super T> observer);
Expand Down
5 changes: 4 additions & 1 deletion src/main/java/io/reactivex/Single.java
Original file line number Diff line number Diff line change
Expand Up @@ -3304,7 +3304,10 @@ public final void subscribe(SingleObserver<? super T> subscriber) {
}

/**
* Override this method in subclasses to handle the incoming SingleObservers.
* Implement this method in subclasses to handle the incoming {@link SingleObserver}s.
* <p>There is no need to call any of the plugin hooks on the current {@code Single} instance or
* the {@code SingleObserver}; all hooks and basic safeguards have been
* applied by {@link #subscribe(SingleObserver)} before this method gets called.
* @param observer the SingleObserver to handle, not null
*/
protected abstract void subscribeActual(@NonNull SingleObserver<? super T> observer);
Expand Down