Skip to content

Commit

Permalink
2.x: improve package JavaDoc (#5648)
Browse files Browse the repository at this point in the history
  • Loading branch information
akarnokd authored Oct 6, 2017
1 parent 4f10ad8 commit 748fb50
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 8 deletions.
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;

0 comments on commit 748fb50

Please sign in to comment.