Skip to content

Commit 748fb50

Browse files
authored
2.x: improve package JavaDoc (ReactiveX#5648)
1 parent 4f10ad8 commit 748fb50

File tree

3 files changed

+13
-8
lines changed

3 files changed

+13
-8
lines changed

src/main/java/io/reactivex/observers/package-info.java

+5-2
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,10 @@
1515
*/
1616

1717
/**
18-
* Default wrappers and implementations for Observer-based consumer classes and interfaces;
19-
* utility classes for creating them from callbacks.
18+
* Default wrappers and implementations for Observer-based consumer classes and interfaces,
19+
* including disposable and resource-tracking variants and
20+
* the {@link io.reactivex.subscribers.TestObserver} that allows unit testing
21+
* {@link io.reactivex.Observable}-, {@link io.reactivex.Single}-, {@link io.reactivex.Maybe}-
22+
* and {@link io.reactivex.Completable}-based flows.
2023
*/
2124
package io.reactivex.observers;

src/main/java/io/reactivex/package-info.java

+4-4
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
* limitations under the License.
1515
*/
1616
/**
17-
* Base reactive classes: Flowable, Observable, Single and Completable; base reactive consumers;
17+
* Base reactive classes: Flowable, Observable, Single, Maybe and Completable; base reactive consumers;
1818
* other common base interfaces.
1919
*
2020
* <p>A library that enables subscribing to and composing asynchronous events and
@@ -43,9 +43,9 @@
4343
*
4444
* <p>Services which intend on exposing data asynchronously and wish
4545
* to allow reactive processing and composition can implement the
46-
* {@link io.reactivex.Flowable}, {@link io.reactivex.Observable}, {@link io.reactivex.Single}
47-
* or {@link io.reactivex.Completable} class which then allow consumers to subscribe to them
48-
* and receive events.</p>
46+
* {@link io.reactivex.Flowable}, {@link io.reactivex.Observable}, {@link io.reactivex.Single},
47+
* {@link io.reactivex.Maybe} or {@link io.reactivex.Completable} class which then allow
48+
* consumers to subscribe to them and receive events.</p>
4949
* <p>Usage examples can be found on the {@link io.reactivex.Flowable}/{@link io.reactivex.Observable} and {@link org.reactivestreams.Subscriber} classes.</p>
5050
*/
5151
package io.reactivex;

src/main/java/io/reactivex/subscribers/package-info.java

+4-2
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,9 @@
1515
*/
1616

1717
/**
18-
* Default wrappers and implementations for Subscriber-based consumer classes and interfaces;
19-
* utility classes for creating them from callbacks.
18+
* Default wrappers and implementations for Subscriber-based consumer classes and interfaces,
19+
* including disposable and resource-tracking variants and
20+
* the {@link io.reactivex.subscribers.TestSubscriber} that allows unit testing
21+
* {@link io.reactivex.Flowable}-based flows.
2022
*/
2123
package io.reactivex.subscribers;

0 commit comments

Comments
 (0)