Add basic documentation to Robot classes #325
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
brcolow
approved these changes
Dec 3, 2016
JordanMartinez
force-pushed
the
documentation
branch
from
e346f0b
to
d9acaae
Compare
JordanMartinez
commented
Dec 3, 2016
| public void dropTo(PointQuery pointQuery); | ||
|
|
||
| /** | ||
| * Moves the mouse horizontally by {@code x} and vertically by {@code y} before releasing the mouse. | ||
| * @param x the amount by which to move the mouse horizontally |
There was a problem hiding this comment.
Fixed.
Yeah, I was wondering if there was any check style rules for that...
|
Is this still a WIP? If so, let me know when you are done. |
|
Sorta.... BaseRobot still needs javadoc, but most of its methods are called by the other Robot interfaces, thus making it redundant. However, there are 3 methods that can be implemented: |
- Other methods are documented in specific robots (e.g. MoveRobot), thus making them redundant to rewrite.
|
K. That should do it. |
|
Merged. Thanks a lot. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.