Skip to content

Commit

Permalink
3.x: Fix javadoc wording of {Publish|Behavior}Processor::offer() (#7328)
Browse files Browse the repository at this point in the history
* 3.x: Fix javadoc wording of {Publish|Behavior}Processor::offer()

* Add subjects and processors to javadoc cleanup
  • Loading branch information
akarnokd authored Aug 30, 2021
1 parent 939b5ce commit b476914
Show file tree
Hide file tree
Showing 3 changed files with 22 additions and 18 deletions.
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

0 comments on commit b476914

Please sign in to comment.