Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

2.x: improve package JavaDoc #5648

Merged
merged 1 commit into from
Oct 6, 2017
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions src/main/java/io/reactivex/observers/package-info.java
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,10 @@
*/

/**
* Default wrappers and implementations for Observer-based consumer classes and interfaces;
* utility classes for creating them from callbacks.
* Default wrappers and implementations for Observer-based consumer classes and interfaces,
* including disposable and resource-tracking variants and
* the {@link io.reactivex.subscribers.TestObserver} that allows unit testing
* {@link io.reactivex.Observable}-, {@link io.reactivex.Single}-, {@link io.reactivex.Maybe}-
* and {@link io.reactivex.Completable}-based flows.
*/
package io.reactivex.observers;
8 changes: 4 additions & 4 deletions src/main/java/io/reactivex/package-info.java
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
* limitations under the License.
*/
/**
* Base reactive classes: Flowable, Observable, Single and Completable; base reactive consumers;
* Base reactive classes: Flowable, Observable, Single, Maybe and Completable; base reactive consumers;
* other common base interfaces.
*
* <p>A library that enables subscribing to and composing asynchronous events and
Expand Down Expand Up @@ -43,9 +43,9 @@
*
* <p>Services which intend on exposing data asynchronously and wish
* to allow reactive processing and composition can implement the
* {@link io.reactivex.Flowable}, {@link io.reactivex.Observable}, {@link io.reactivex.Single}
* or {@link io.reactivex.Completable} class which then allow consumers to subscribe to them
* and receive events.</p>
* {@link io.reactivex.Flowable}, {@link io.reactivex.Observable}, {@link io.reactivex.Single},
* {@link io.reactivex.Maybe} or {@link io.reactivex.Completable} class which then allow
* consumers to subscribe to them and receive events.</p>
* <p>Usage examples can be found on the {@link io.reactivex.Flowable}/{@link io.reactivex.Observable} and {@link org.reactivestreams.Subscriber} classes.</p>
*/
package io.reactivex;
Expand Down
6 changes: 4 additions & 2 deletions src/main/java/io/reactivex/subscribers/package-info.java
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,9 @@
*/

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