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

3.x: Cleanup and prettify Javadocs, widen XOperator throws #6785

Merged
merged 3 commits into from
Dec 21, 2019

Conversation

akarnokd
Copy link
Member

This PR clears up some javadocs and widens the throws on the various Operator interfaces:

  • Link to Integer.MAX_VALUE and Long.MAX_VALUEs.
  • Add links to types and {@code TheType} for other appearances.
  • Wrap event type indicators into {@code } tags.
  • Wrap boolean outcomes into {@code } tags.
  • Wrap null mentions into {@code } tags.
  • Apply nullability annotations.
  • Fix wording and copy-paste errors.

@codecov
Copy link

codecov bot commented Dec 20, 2019

Codecov Report

Merging #6785 into 3.x will decrease coverage by 0.01%.
The diff coverage is 100%.

Impacted file tree graph

@@             Coverage Diff              @@
##                3.x    #6785      +/-   ##
============================================
- Coverage     98.24%   98.22%   -0.02%     
+ Complexity     6255     6253       -2     
============================================
  Files           690      690              
  Lines         45218    45218              
  Branches       6220     6220              
============================================
- Hits          44426    44417       -9     
- Misses          276      281       +5     
- Partials        516      520       +4
Impacted Files Coverage Δ Complexity Δ
...a/io/reactivex/rxjava3/observers/SafeObserver.java 100% <ø> (ø) 18 <0> (ø) ⬇️
...o/reactivex/rxjava3/processors/AsyncProcessor.java 98.95% <ø> (ø) 45 <0> (ø) ⬇️
...in/java/io/reactivex/rxjava3/schedulers/Timed.java 100% <ø> (ø) 13 <0> (ø) ⬇️
...eactivex/rxjava3/processors/BehaviorProcessor.java 96.58% <ø> (-2.44%) 51 <0> (ø)
...reactivex/rxjava3/processors/UnicastProcessor.java 100% <ø> (ø) 68 <0> (ø) ⬇️
.../main/java/io/reactivex/rxjava3/core/Flowable.java 100% <ø> (ø) 577 <0> (ø) ⬇️
...tivex/rxjava3/disposables/CompositeDisposable.java 98.14% <ø> (ø) 39 <0> (ø) ⬇️
...o/reactivex/rxjava3/core/BackpressureStrategy.java 100% <ø> (ø) 1 <0> (ø) ⬇️
...vex/rxjava3/exceptions/UndeliverableException.java 100% <ø> (ø) 1 <0> (ø) ⬇️
...ctivex/rxjava3/internal/util/QueueDrainHelper.java 98.61% <ø> (-1.39%) 57 <0> (-1)
... and 46 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 166c529...83d19b4. Read the comment docs.

@akarnokd akarnokd merged commit dba6705 into ReactiveX:3.x Dec 21, 2019
@akarnokd akarnokd deleted the JavadocCleanup_1220 branch December 21, 2019 10:08
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.

1 participant