Skip to content

Commit 20e8fa1

Browse files
committed
Converts the documentation to JavaDoc instead of ScalaDoc
1 parent 3cb88b9 commit 20e8fa1

File tree

6 files changed

+24
-24
lines changed

6 files changed

+24
-24
lines changed

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

+2-2
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
/**
66
* A Consumer is the logical sink of elements of a given type.
7-
* The underlying implementation is done by way of a [[org.reactivestreams.spi.Subscriber]].
7+
* 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.
99
*
1010
* Implementations of this interface will typically offer domain- or language-specific
@@ -13,7 +13,7 @@
1313
public interface Consumer<T> {
1414

1515
/**
16-
* Get the underlying Subscriber for this Consumer. This method should only be used by
16+
* Get the underlying {@link org.reactivestreams.spi.Subscriber Subscriber} for this Consumer. This method should only be used by
1717
* implementations of this API.
1818
*
1919
* @return the underlying subscriber for this consumer

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
* A Processor is a stand-alone representation of a transformation for
55
* elements from In to Out types. Implementations of this API will provide
66
* factory methods for creating Processors and connecting them to
7-
* [[Producer]] and [[Consumer]].
7+
* {@link org.reactivestreams.api.Producer Producer} and {@link org.reactivestreams.api.Consumer Consumer}.
88
*/
99
public interface Processor<I, O> extends Consumer<I>, Producer<O> {
1010
}

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

+4-4
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
/**
66
* A Producer is the logical source of elements of a given type.
7-
* The underlying implementation is done by way of a [[org.reactivestreams.spi.Publisher]].
7+
* 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.
1010
*
@@ -14,7 +14,7 @@
1414
public interface Producer<T> {
1515

1616
/**
17-
* Get the underlying Publisher for this Producer. This method should only be used by
17+
* Get the underlying {@link org.reactivestreams.spi.Publisher Publisher} for this Producer. This method should only be used by
1818
* implementations of this API.
1919
*
2020
* @return the underlying publisher for this producer
@@ -23,8 +23,8 @@ public interface Producer<T> {
2323

2424
/**
2525
* Connect the given consumer to this producer. This means that the
26-
* Subscriber underlying the Consumer subscribes to this Producer’s
27-
* underlying Publisher, which will initiate the transfer of the produced
26+
* Subscriber underlying the {@link org.reactivestreams.api.Consumer Consumer} subscribes to this Producer’s
27+
* underlying {@link org.reactivestreams.spi.Publisher Publisher}, which will initiate the transfer of the produced
2828
* stream of elements from producer to consumer until either of three things
2929
* happen:
3030
* <ul>

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

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
package org.reactivestreams.spi;
22

33
/**
4-
* A Publisher is a source of elements of a given type. One or more [[Subscriber]] may be connected
4+
* A Publisher is a source of elements of a given type. One or more {@link org.reactivestreams.spi.Subscriber Subscriber} may be connected
55
* to this Publisher in order to receive the published elements, contingent on availability of these
6-
* elements as well as the presence of demand signaled by the Subscriber via [[Subscription#requestMore]].
6+
* elements as well as the presence of demand signaled by the Subscriber via {@link org.reactivestreams.spi.Subscription#requestMore(int) requestMore}.
77
*/
88
public interface Publisher<T> {
99

1010
/**
11-
* Subscribe the given [[Subscriber]] to this Publisher. A Subscriber can at most be subscribed once
11+
* 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.
1313
*
1414
* @param subscriber The subscriber to register with this publisher.

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

+8-8
Original file line numberDiff line numberDiff line change
@@ -1,39 +1,39 @@
11
package org.reactivestreams.spi;
22

33
/**
4-
* A Subscriber receives elements from a [[Publisher]] based on the [[Subscription]] it has.
4+
* A Subscriber receives elements from a {@link org.reactivestreams.spi.Publisher Publisher} based on the {@link org.reactivestreams.spi.Subscription Subscription} it has.
55
* The Publisher may supply elements as they become available, the Subscriber signals demand via
6-
* [[Subscription#requestMore]] and elements from when supply and demand are both present.
6+
* {@link org.reactivestreams.spi.Subscription#requestMore(int) requestMore} and elements from when supply and demand are both present.
77
*/
88
public interface Subscriber<T> {
99

1010
/**
11-
* The [[Publisher]] generates a [[Subscription]] upon [[Publisher#subscribe]] and passes
11+
* 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
13-
* the subscription request by calling [[#onError]] instead.
13+
* the subscription request by calling {@link #onError onError} instead.
1414
*
1515
* @param subscription The subscription which connects this subscriber to its publisher.
1616
*/
1717
public void onSubscribe(Subscription subscription);
1818

1919
/**
20-
* The [[Publisher]] calls this method to pass one element to this Subscriber. The element
20+
* The {@link org.reactivestreams.spi.Publisher Publisher} calls this method to pass one element to this Subscriber. The element
2121
* must not be <code>null</code>. The Publisher must not call this method more often than
22-
* the Subscriber has signaled demand for via the corresponding [[Subscription]].
22+
* the Subscriber has signaled demand for via the corresponding {@link org.reactivestreams.spi.Subscription Subscription}.
2323
*
2424
* @param element The element that is passed from publisher to subscriber.
2525
*/
2626
public void onNext(T element);
2727

2828
/**
29-
* The [[Publisher]] calls this method in order to signal that it terminated normally.
29+
* The {@link org.reactivestreams.spi.Publisher Publisher} calls this method in order to signal that it terminated normally.
3030
* No more elements will be forthcoming and none of the Subscriber’s methods will be
3131
* called hereafter.
3232
*/
3333
public void onComplete();
3434

3535
/**
36-
* The [[Publisher]] calls this method to signal that the stream of elements has failed
36+
* The {@link org.reactivestreams.spi.Publisher Publisher} calls this method to signal that the stream of elements has failed
3737
* and is being aborted. The Subscriber should abort its processing as soon as possible.
3838
* No more elements will be forthcoming and none of the Subscriber’s methods will be
3939
* called hereafter.

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

+6-6
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,25 @@
11
package org.reactivestreams.spi;
22

33
/**
4-
* A Subscription models the relationship between a [[Publisher]] and a [[Subscriber]].
4+
* A Subscription models the relationship between a {@link org.reactivestreams.spi.Publisher Publisher} and a {@link org.reactivestreams.spi.Subscriber Subscriber}.
55
* The Subscriber receives a Subscription so that it can ask for elements to be delivered
6-
* using [[Subscription#requestMore]]. The Subscription can be disposed of by canceling it.
6+
* using {@link org.reactivestreams.spi.Subscription#requestMore(int) requestMore}. The Subscription can be disposed of by canceling it.
77
*/
88
public interface Subscription {
99

1010
/**
11-
* Cancel this subscription. The [[Publisher]] to which produced this Subscription
12-
* will eventually stop sending more elements to the [[Subscriber]] which owns
11+
* Cancel this subscription. The {@link org.reactivestreams.spi.Publisher Publisher} to which produced this Subscription
12+
* will eventually stop sending more elements to the {@link org.reactivestreams.spi.Subscriber Subscriber} which owns
1313
* this Subscription. This may happen before the requested number of elements has
1414
* been delivered, even if the Publisher would still have more elements.
1515
*/
1616
public void cancel();
1717

1818
/**
19-
* Request more data from the [[Publisher]] which produced this Subscription.
19+
* Request more data from the {@link org.reactivestreams.spi.Publisher Publisher} which produced this 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
22-
* the [[Subscriber]] which owns this Subscription.
22+
* the {@link org.reactivestreams.spi.Subscriber Subscriber} which owns this Subscription.
2323
*
2424
* @param elements The number of elements requested.
2525
*/

0 commit comments

Comments
 (0)