Skip to content

Commit 1b05a28

Browse files
committed
3.x: Fix javadoc wording of {Publish|Behavior}Processor::offer()
1 parent 939b5ce commit 1b05a28

File tree

2 files changed

+12
-18
lines changed

2 files changed

+12
-18
lines changed

src/main/java/io/reactivex/rxjava3/processors/BehaviorProcessor.java

Lines changed: 6 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -306,17 +306,14 @@ public void onComplete() {
306306
}
307307

308308
/**
309-
* Tries to emit the item to all currently subscribed Subscribers if all of them
310-
* has requested some value, returns false otherwise.
309+
* Tries to emit the item to all currently subscribed {@link Subscriber}s if all of them
310+
* has requested some value, returns {@code false} otherwise.
311311
* <p>
312-
* This method should be called in a sequential manner just like the onXXX methods
313-
* of the PublishProcessor.
314-
* <p>
315-
* Calling with a null value will terminate the PublishProcessor and a NullPointerException
316-
* is signaled to the Subscribers.
312+
* This method should be called in a sequential manner just like the {@code onXXX} methods
313+
* of this {@code BehaviorProcessor}.
317314
* <p>History: 2.0.8 - experimental
318-
* @param t the item to emit, not null
319-
* @return true if the item was emitted to all Subscribers
315+
* @param t the item to emit, not {@code null}
316+
* @return {@code true} if the item was emitted to all {@code Subscriber}s
320317
* @throws NullPointerException if {@code t} is {@code null}
321318
* @since 2.2
322319
*/

src/main/java/io/reactivex/rxjava3/processors/PublishProcessor.java

Lines changed: 6 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -271,17 +271,14 @@ public void onComplete() {
271271
}
272272

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

0 commit comments

Comments
 (0)