Skip to content
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

3.x: Fix javadoc wording of {Publish|Behavior}Processor::offer() #7328

Merged
merged 2 commits into from
Aug 30, 2021
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
10 changes: 10 additions & 0 deletions gradle/javadoc_cleanup.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,16 @@ task javadocCleanup(dependsOn: "javadoc") doLast {

fixJavadocFile(rootProject.file('build/docs/javadoc/io/reactivex/rxjava3/subjects/ReplaySubject.html'))
fixJavadocFile(rootProject.file('build/docs/javadoc/io/reactivex/rxjava3/processors/ReplayProcessor.html'))
fixJavadocFile(rootProject.file('build/docs/javadoc/io/reactivex/rxjava3/subjects/PublishSubject.html'))
fixJavadocFile(rootProject.file('build/docs/javadoc/io/reactivex/rxjava3/processors/PublishProcessor.html'))
fixJavadocFile(rootProject.file('build/docs/javadoc/io/reactivex/rxjava3/subjects/AsyncSubject.html'))
fixJavadocFile(rootProject.file('build/docs/javadoc/io/reactivex/rxjava3/processors/AsyncProcessor.html'))
fixJavadocFile(rootProject.file('build/docs/javadoc/io/reactivex/rxjava3/subjects/BehaviorSubject.html'))
fixJavadocFile(rootProject.file('build/docs/javadoc/io/reactivex/rxjava3/processors/BehaviorProcessor.html'))
fixJavadocFile(rootProject.file('build/docs/javadoc/io/reactivex/rxjava3/processors/MulticastProcessor.html'))
fixJavadocFile(rootProject.file('build/docs/javadoc/io/reactivex/rxjava3/subjects/UnicastSubject.html'))
fixJavadocFile(rootProject.file('build/docs/javadoc/io/reactivex/rxjava3/processors/UnicastProcessor.html'))

fixJavadocFile(rootProject.file('build/docs/javadoc/io/reactivex/rxjava3/plugins/RxJavaPlugins.html'))

fixJavadocFile(rootProject.file('build/docs/javadoc/io/reactivex/rxjava3/parallel/ParallelFlowable.html'))
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -306,17 +306,14 @@ public void onComplete() {
}

/**
* Tries to emit the item to all currently subscribed Subscribers if all of them
* has requested some value, returns false otherwise.
* Tries to emit the item to all currently subscribed {@link Subscriber}s if all of them
* has requested some value, returns {@code false} otherwise.
* <p>
* This method should be called in a sequential manner just like the onXXX methods
* of the PublishProcessor.
* <p>
* Calling with a null value will terminate the PublishProcessor and a NullPointerException
* is signaled to the Subscribers.
* This method should be called in a sequential manner just like the {@code onXXX} methods
* of this {@code BehaviorProcessor}.
* <p>History: 2.0.8 - experimental
* @param t the item to emit, not null
* @return true if the item was emitted to all Subscribers
* @param t the item to emit, not {@code null}
* @return {@code true} if the item was emitted to all {@code Subscriber}s
* @throws NullPointerException if {@code t} is {@code null}
* @since 2.2
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -271,17 +271,14 @@ public void onComplete() {
}

/**
* Tries to emit the item to all currently subscribed Subscribers if all of them
* has requested some value, returns false otherwise.
* Tries to emit the item to all currently subscribed {@link Subscriber}s if all of them
* has requested some value, returns {@code false} otherwise.
* <p>
* This method should be called in a sequential manner just like the onXXX methods
* of the PublishProcessor.
* <p>
* Calling with a null value will terminate the PublishProcessor and a NullPointerException
* is signaled to the Subscribers.
* This method should be called in a sequential manner just like the {@code onXXX} methods
* of this {@code PublishProcessor}.
* <p>History: 2.0.8 - experimental
* @param t the item to emit, not null
* @return true if the item was emitted to all Subscribers
* @param t the item to emit, not {@code null}
* @return {@code true} if the item was emitted to all {@code Subscriber}s
* @throws NullPointerException if {@code t} is {@code null}
* @since 2.2
*/
Expand Down