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: Fix Javadoc warnings, links to the JDK types #5861

Merged
merged 1 commit into from
Feb 23, 2018

Conversation

akarnokd
Copy link
Member

The definition of multiple external links was wrong in build.gradle where the options.links() is actually defined as String... and multiple calls are not additional. This made the generated JavaDoc not have links to the JDK types. The fix now properly uses the varargs of the method. In addition, somehow the plain http:// still wouldn't generate the proper links probably because they are redirected to https:// for which the javadoc tool is not prepared.

In addition, 4 dangling <p> tags were showing up as warnings and have been removed.

options.links("http://docs.oracle.com/javase/7/docs/api/")
options.links("http://www.reactive-streams.org/reactive-streams-${reactiveStreamsVersion}-javadoc/")
options.links(
"https://docs.oracle.com/javase/7/docs/api/",
Copy link
Contributor

Choose a reason for hiding this comment

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

Any reason not to use 8 or 9?

Copy link
Member Author

Choose a reason for hiding this comment

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

No particular reason.

Copy link
Contributor

Choose a reason for hiding this comment

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

Since RxJava 2.x is compatible with JDK 6, should we link 6?

Copy link
Member Author

Choose a reason for hiding this comment

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

Well, the Javadoc is built with Java 8 and the JDK 6 docs look ugly to me anyway. Style-wise, 8 would be more seamless, 9 would be nicer due to the search box. Anything 7+ may trigger confusion about the JDK's default methods not available in Android or the misunderstanding that it's only the docs that link to Java 9, not that RxJava now depends on Java 9.

@codecov
Copy link

codecov bot commented Feb 22, 2018

Codecov Report

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

Impacted file tree graph

@@             Coverage Diff              @@
##                2.x    #5861      +/-   ##
============================================
- Coverage     96.54%   96.49%   -0.05%     
+ Complexity     5858     5850       -8     
============================================
  Files           646      646              
  Lines         42640    42640              
  Branches       5910     5910              
============================================
- Hits          41166    41145      -21     
- Misses          566      577      +11     
- Partials        908      918      +10
Impacted Files Coverage Δ Complexity Δ
...in/java/io/reactivex/subjects/BehaviorSubject.java 86.24% <0%> (-5.83%) 54% <0%> (ø)
.../operators/flowable/FlowableBlockingSubscribe.java 91.89% <0%> (-5.41%) 9% <0%> (-1%)
...internal/operators/completable/CompletableAmb.java 94.91% <0%> (-5.09%) 10% <0%> (-1%)
...tivex/internal/observers/FutureSingleObserver.java 94.33% <0%> (-3.78%) 24% <0%> (-1%)
...reactivex/internal/operators/single/SingleAmb.java 96.36% <0%> (-3.64%) 9% <0%> (-1%)
...ternal/operators/observable/ObservablePublish.java 92.98% <0%> (-3.51%) 11% <0%> (ø)
...ernal/operators/flowable/FlowableFlatMapMaybe.java 91.78% <0%> (-3.39%) 2% <0%> (ø)
...va/io/reactivex/internal/queue/SpscArrayQueue.java 97.61% <0%> (-2.39%) 22% <0%> (-1%)
...rnal/operators/flowable/FlowableSkipLastTimed.java 95.91% <0%> (-2.05%) 2% <0%> (ø)
.../internal/disposables/ListCompositeDisposable.java 98% <0%> (-2%) 34% <0%> (-1%)
... and 28 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 10210e6...d68e564. Read the comment docs.

options.links("http://docs.oracle.com/javase/7/docs/api/")
options.links("http://www.reactive-streams.org/reactive-streams-${reactiveStreamsVersion}-javadoc/")
options.links(
"https://docs.oracle.com/javase/7/docs/api/",
Copy link
Contributor

Choose a reason for hiding this comment

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

Since RxJava 2.x is compatible with JDK 6, should we link 6?

@akarnokd akarnokd merged commit 237084f into ReactiveX:2.x Feb 23, 2018
@akarnokd akarnokd deleted the JavadocExternalLinksFix branch February 23, 2018 10:07
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