Skip to content

1.x: add missing javadoc elements, fix some descriptions #4039

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

Merged
merged 2 commits into from
Jun 20, 2016

Conversation

akarnokd
Copy link
Member

  • Fixes to Javadoc warnings
  • Type arguments
  • Missing descriptions

@@ -1127,6 +1132,7 @@ public final Completable compose(CompletableTransformer transformer) {
* <dd>{@code andThen} does not operate by default on a particular {@link Scheduler}.</dd>
* </dl>
*
* @param <T> the value type of the next Observable
Copy link
Contributor

Choose a reason for hiding this comment

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

of next Single

Copy link
Member Author

Choose a reason for hiding this comment

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

Thanks. Once I'm done with the rearchitecting in the 2.x branch, I'll update the PR.

@akarnokd
Copy link
Member Author

Fixed, @artem-zinnatullin .

@@ -29,7 +29,7 @@
*
* @param <M> the event/message type
*/
interface MessagePassingQueue<M> {
public interface MessagePassingQueue<M> {
Copy link
Contributor

Choose a reason for hiding this comment

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

Why public?

Copy link
Member Author

Choose a reason for hiding this comment

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

javadoc complained that the spsc queues reference it but it is not visible enough.

Copy link
Contributor

Choose a reason for hiding this comment

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

Ah, because spsc queues are public but interface they're implementing is
not. Ok then!

On Mon, 20 Jun 2016, 16:00 David Karnok, [email protected] wrote:

In src/main/java/rx/internal/util/unsafe/MessagePassingQueue.java
#4039 (comment):

@@ -29,7 +29,7 @@
*

  • @param the event/message type
    */
    -interface MessagePassingQueue {
    +public interface MessagePassingQueue {

javadoc complained that the spsc queues reference it but it is not
visible enough.


You are receiving this because you were mentioned.

Reply to this email directly, view it on GitHub
https://github.com/ReactiveX/RxJava/pull/4039/files/12e00d19d0ac9c82eefd8f83a6f6bba7e0ea53b2#r67684701,
or mute the thread
https://github.com/notifications/unsubscribe/AA7B3HF0gIVikH3WAb6RfWHi7_UVir0Lks5qNo78gaJpZM4I5a4v
.

@artem-zinnatullin
Copy link
Contributor

👍

1 similar comment
@stevegury
Copy link
Member

👍

@akarnokd
Copy link
Member Author

Thanks @stevegury & @artem-zinnatullin

@DavidMGross let me know if you are okay with the update.

@DavidMGross
Copy link
Collaborator

👍 Love it. Nice to see those @warn messages going away.

@akarnokd akarnokd merged commit 0a5f884 into ReactiveX:1.x Jun 20, 2016
@akarnokd akarnokd deleted the Cleanup0620 branch June 20, 2016 20:57
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.

4 participants