-
Notifications
You must be signed in to change notification settings - Fork 7.6k
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
Conversation
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/", |
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
No particular reason.
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
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 Report
@@ 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
Continue to review full report at Codecov.
|
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/", |
There was a problem hiding this comment.
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?
The definition of multiple external links was wrong in
build.gradle
where theoptions.links()
is actually defined asString...
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 plainhttp://
still wouldn't generate the proper links probably because they are redirected tohttps://
for which the javadoc tool is not prepared.In addition, 4 dangling
<p>
tags were showing up as warnings and have been removed.