Skip to content

Commit 3d45e41

Browse files
committed
Adds paragraph breaks to JavaDoc
1 parent 20e8fa1 commit 3d45e41

File tree

5 files changed

+6
-15
lines changed

5 files changed

+6
-15
lines changed

spi/src/main/java/org/reactivestreams/api/Consumer.java

+1-2
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
* A Consumer is the logical sink of elements of a given type.
77
* The underlying implementation is done by way of a {@link org.reactivestreams.spi.Subscriber Subscriber}.
88
* This interface is the user-level API for a sink while a Subscriber is the SPI.
9-
*
9+
* <p>
1010
* Implementations of this interface will typically offer domain- or language-specific
1111
* methods for transforming or otherwise interacting with the stream of elements.
1212
*/
@@ -15,7 +15,6 @@ public interface Consumer<T> {
1515
/**
1616
* Get the underlying {@link org.reactivestreams.spi.Subscriber Subscriber} for this Consumer. This method should only be used by
1717
* implementations of this API.
18-
*
1918
* @return the underlying subscriber for this consumer
2019
*/
2120
public Subscriber<T> getSubscriber();

spi/src/main/java/org/reactivestreams/api/Producer.java

+2-3
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
* The underlying implementation is done by way of a {@link org.reactivestreams.spi.Publisher Publisher}.
88
* This interface is the user-level API for a source while a Publisher is the
99
* SPI.
10-
*
10+
* <p>
1111
* Implementations of this interface will typically offer domain- or language-specific
1212
* methods for transforming or otherwise interacting with the produced stream of elements.
1313
*/
@@ -16,7 +16,6 @@ public interface Producer<T> {
1616
/**
1717
* Get the underlying {@link org.reactivestreams.spi.Publisher Publisher} for this Producer. This method should only be used by
1818
* implementations of this API.
19-
*
2019
* @return the underlying publisher for this producer
2120
*/
2221
public Publisher<T> getPublisher();
@@ -27,12 +26,12 @@ public interface Producer<T> {
2726
* underlying {@link org.reactivestreams.spi.Publisher Publisher}, which will initiate the transfer of the produced
2827
* stream of elements from producer to consumer until either of three things
2928
* happen:
29+
* <p>
3030
* <ul>
3131
* <li>The stream ends normally (no more elements available).</li>
3232
* <li>The producer encounters a fatal error condition.</li>
3333
* <li>The consumer cancels the reception of more elements.</li>
3434
* </ul>
35-
*
3635
* @param consumer The consumer to register with this producer.
3736
*/
3837
public void produceTo(Consumer<T> consumer);

spi/src/main/java/org/reactivestreams/spi/Publisher.java

-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,6 @@ public interface Publisher<T> {
1010
/**
1111
* Subscribe the given {@link org.reactivestreams.spi.Subscriber Subscriber} to this Publisher. A Subscriber can at most be subscribed once
1212
* to a given Publisher, and to at most one Publisher in total.
13-
*
1413
* @param subscriber The subscriber to register with this publisher.
1514
*/
1615
public void subscribe(Subscriber<T> subscriber);

spi/src/main/java/org/reactivestreams/spi/Subscriber.java

+3-8
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,6 @@ public interface Subscriber<T> {
1111
* The {@link org.reactivestreams.spi.Publisher Publisher} generates a {@link org.reactivestreams.spi.Subscription Subscription} upon {@link org.reactivestreams.spi.Publisher#subscribe(org.reactivestreams.spi.Subscriber) subscribe} and passes
1212
* it on to the Subscriber named there using this method. The Publisher may choose to reject
1313
* the subscription request by calling {@link #onError onError} instead.
14-
*
1514
* @param subscription The subscription which connects this subscriber to its publisher.
1615
*/
1716
public void onSubscribe(Subscription subscription);
@@ -20,28 +19,24 @@ public interface Subscriber<T> {
2019
* The {@link org.reactivestreams.spi.Publisher Publisher} calls this method to pass one element to this Subscriber. The element
2120
* must not be <code>null</code>. The Publisher must not call this method more often than
2221
* the Subscriber has signaled demand for via the corresponding {@link org.reactivestreams.spi.Subscription Subscription}.
23-
*
2422
* @param element The element that is passed from publisher to subscriber.
2523
*/
2624
public void onNext(T element);
2725

2826
/**
2927
* The {@link org.reactivestreams.spi.Publisher Publisher} calls this method in order to signal that it terminated normally.
30-
* No more elements will be forthcoming and none of the Subscriber’s methods will be
31-
* called hereafter.
28+
* No more elements will be forthcoming and none of the Subscriber’s methods will be called hereafter.
3229
*/
3330
public void onComplete();
3431

3532
/**
3633
* The {@link org.reactivestreams.spi.Publisher Publisher} calls this method to signal that the stream of elements has failed
3734
* and is being aborted. The Subscriber should abort its processing as soon as possible.
38-
* No more elements will be forthcoming and none of the Subscriber’s methods will be
39-
* called hereafter.
40-
*
35+
* No more elements will be forthcoming and none of the Subscriber’s methods will be called hereafter.
36+
* <p>
4137
* This method is not intended to pass validation errors or similar from Publisher to Subscriber
4238
* in order to initiate an orderly shutdown of the exchange; it is intended only for fatal
4339
* failure conditions which make it impossible to continue processing further elements.
44-
*
4540
* @param cause An exception which describes the reason for tearing down this stream.
4641
*/
4742
public void onError(Throwable cause);

spi/src/main/java/org/reactivestreams/spi/Subscription.java

-1
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,6 @@ public interface Subscription {
2020
* The number of requested elements is cumulative to the number requested previously.
2121
* The Publisher may eventually publish up to the requested number of elements to
2222
* the {@link org.reactivestreams.spi.Subscriber Subscriber} which owns this Subscription.
23-
*
2423
* @param elements The number of elements requested.
2524
*/
2625
public void requestMore(int elements);

0 commit comments

Comments
 (0)