Skip to content

2.x: Fix Javadoc warnings, links to the JDK types #5861

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Feb 23, 2018
Merged

2.x: Fix Javadoc warnings, links to the JDK types #5861

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions build.gradle
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,8 +91,10 @@ javadoc {
options.addStringOption("doctitle").value = ""
options.addStringOption("header").value = ""

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.

"http://www.reactive-streams.org/reactive-streams-${reactiveStreamsVersion}-javadoc/"
)

if (JavaVersion.current().isJava7()) {
// "./gradle/stylesheet.css" only supports Java 7
Expand Down
1 change: 0 additions & 1 deletion src/main/java/io/reactivex/CompletableObserver.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,6 @@
* Calling the {@code CompletableObserver}'s method must happen in a serialized fashion, that is, they must not
* be invoked concurrently by multiple threads in an overlapping fashion and the invocation pattern must
* adhere to the following protocol:
* <p>
* <pre><code> onSubscribe (onError | onComplete)?</code></pre>
* <p>
* Subscribing a {@code CompletableObserver} to multiple {@code CompletableSource}s is not recommended. If such reuse
Expand Down
1 change: 0 additions & 1 deletion src/main/java/io/reactivex/MaybeObserver.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,6 @@
* Calling the {@code MaybeObserver}'s method must happen in a serialized fashion, that is, they must not
* be invoked concurrently by multiple threads in an overlapping fashion and the invocation pattern must
* adhere to the following protocol:
* <p>
* <pre><code> onSubscribe (onSuccess | onError | onComplete)?</code></pre>
* <p>
* Note that unlike with the {@code Observable} protocol, {@link #onComplete()} is not called after the success item has been
Expand Down
1 change: 0 additions & 1 deletion src/main/java/io/reactivex/Observer.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,6 @@
* Calling the {@code Observer}'s method must happen in a serialized fashion, that is, they must not
* be invoked concurrently by multiple threads in an overlapping fashion and the invocation pattern must
* adhere to the following protocol:
* <p>
* <pre><code> onSubscribe onNext* (onError | onComplete)?</code></pre>
* <p>
* Subscribing an {@code Observer} to multiple {@code ObservableSource}s is not recommended. If such reuse
Expand Down
1 change: 0 additions & 1 deletion src/main/java/io/reactivex/SingleObserver.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,6 @@
* Calling the {@code SingleObserver}'s method must happen in a serialized fashion, that is, they must not
* be invoked concurrently by multiple threads in an overlapping fashion and the invocation pattern must
* adhere to the following protocol:
* <p>
* <pre><code> onSubscribe (onSuccess | onError)?</code></pre>
* <p>
* Subscribing a {@code SingleObserver} to multiple {@code SingleSource}s is not recommended. If such reuse
Expand Down