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: Improved XSubject JavaDocs #5802

Merged
merged 2 commits into from
Jan 10, 2018
Merged

Conversation

akarnokd
Copy link
Member

@akarnokd akarnokd commented Jan 9, 2018

This PR adds more detailed JavaDoc descriptions to the various XSubject types.

Some of them are missing a marble diagram which will be created (or found) in a separate PR after this PR.

The package-info.java has been extended as well.

@akarnokd akarnokd added this to the 2.2 milestone Jan 9, 2018
@codecov
Copy link

codecov bot commented Jan 9, 2018

Codecov Report

Merging #5802 into 2.x will decrease coverage by 0.05%.
The diff coverage is n/a.

Impacted file tree graph

@@             Coverage Diff              @@
##                2.x    #5802      +/-   ##
============================================
- Coverage     96.23%   96.18%   -0.06%     
+ Complexity     5814     5807       -7     
============================================
  Files           634      634              
  Lines         41647    41647              
  Branches       5776     5776              
============================================
- Hits          40081    40057      -24     
- Misses          620      634      +14     
- Partials        946      956      +10
Impacted Files Coverage Δ Complexity Δ
...main/java/io/reactivex/subjects/ReplaySubject.java 98% <ø> (+0.44%) 49 <0> (ø) ⬇️
...in/java/io/reactivex/subjects/BehaviorSubject.java 86.24% <ø> (ø) 54 <0> (ø) ⬇️
.../main/java/io/reactivex/subjects/MaybeSubject.java 97.75% <ø> (-2.25%) 45 <0> (-1)
...java/io/reactivex/subjects/CompletableSubject.java 100% <ø> (ø) 36 <0> (ø) ⬇️
...ain/java/io/reactivex/subjects/UnicastSubject.java 98.1% <ø> (ø) 61 <0> (ø) ⬇️
...ain/java/io/reactivex/subjects/PublishSubject.java 97.8% <ø> (-2.2%) 38 <0> (-1)
...main/java/io/reactivex/subjects/SingleSubject.java 100% <ø> (ø) 38 <0> (ø) ⬇️
.../main/java/io/reactivex/subjects/AsyncSubject.java 99.06% <ø> (ø) 52 <0> (ø) ⬇️
...ava/io/reactivex/processors/BehaviorProcessor.java 90.13% <ø> (+0.89%) 59 <0> (ø) ⬇️
src/main/java/io/reactivex/subjects/Subject.java 100% <ø> (ø) 3 <0> (ø) ⬇️
... and 30 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update f00533c...6ebe886. Read the comment docs.

Copy link
Contributor

@artem-zinnatullin artem-zinnatullin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

* given {@code Disposable} being disposed immediately.
* <p>
* Calling {@link #onNext(Object)}, {@link #onError(Throwable)} and {@link #onComplete()}
* is still required to be serialized (called from the same thread or called non-overlappingly from different threads
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: After reading this multiple times I kinda want to remove "still" from the sentence

* Example usage:
* <pre> {@code

ReplaySubject<Object> subject = new ReplaySubject<>();
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice catch

@akarnokd akarnokd merged commit 7194f3e into ReactiveX:2.x Jan 10, 2018
@akarnokd akarnokd deleted the SubjectBetterJavaDocs branch January 10, 2018 08:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants