Skip to content

Fix param and return javadoc statements#622

Merged
QuintinWillison merged 1 commit intomainfrom
fix-param-and-return-javadoc
Oct 19, 2020
Merged

Fix param and return javadoc statements#622
QuintinWillison merged 1 commit intomainfrom
fix-param-and-return-javadoc

Conversation

@vzhikserg
Copy link
Copy Markdown
Contributor

This fix helps to limit the number of warnings displayed while building the Android-specific library

...\java\io\ably\lib\types\Callback.java:19: warning - @param argument "reason:" is not a parameter name.
...\java\io\ably\lib\types\Capability.java:29: warning - @param argument "capability:" is not a parameter name.
...\java\io\ably\lib\types\ClientOptions.java:27: warning - @param argument "key:" is not a parameter name.

@vzhikserg vzhikserg added the documentation Improvements or additions to public interface documentation (API reference or readme). label Oct 13, 2020
@vzhikserg vzhikserg self-assigned this Oct 13, 2020
Copy link
Copy Markdown
Contributor

@QuintinWillison QuintinWillison left a comment

Choose a reason for hiding this comment

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

Apologies for the late review, @vzhikserg ... I should have looked at this much sooner. Thanks for doing this.

I'm going to save myself time by not reviewing in depth. But, given it's only commentary changes, I'm going to trust you and assume it improves things. 😁

@QuintinWillison QuintinWillison merged commit 6e7f5b8 into main Oct 19, 2020
@QuintinWillison QuintinWillison deleted the fix-param-and-return-javadoc branch October 19, 2020 10:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to public interface documentation (API reference or readme).

Development

Successfully merging this pull request may close these issues.

2 participants