Skip to content

Commit

Permalink
obligatory javadoc fixes for release
Browse files Browse the repository at this point in the history
  • Loading branch information
JoonasVali committed Feb 10, 2019
1 parent c3455a3 commit 0f38653
Show file tree
Hide file tree
Showing 3 changed files with 28 additions and 4 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -56,41 +56,53 @@ public static MouseMotionFactory getDefault() {

/**
* see {@link MouseMotionNature#getSystemCalls()}
*
* @return the systemcalls
*/
public SystemCalls getSystemCalls() {
return nature.getSystemCalls();
}

/**
* see {@link MouseMotionNature#setSystemCalls(SystemCalls)}
*
* @param systemCalls the systemcalls
*/
public void setSystemCalls(SystemCalls systemCalls) {
nature.setSystemCalls(systemCalls);
}

/**
* see {@link MouseMotionNature#getDeviationProvider()}
*
* @return the deviation provider
*/
public DeviationProvider getDeviationProvider() {
return nature.getDeviationProvider();
}

/**
* see {@link MouseMotionNature#setDeviationProvider(DeviationProvider)}
*
* @param deviationProvider the deviation provider
*/
public void setDeviationProvider(DeviationProvider deviationProvider) {
nature.setDeviationProvider(deviationProvider);
}

/**
* see {@link MouseMotionNature#getNoiseProvider()}
*
* @return the noise provider
*/
public NoiseProvider getNoiseProvider() {
return nature.getNoiseProvider();
}

/**
* see {@link MouseMotionNature#setNoiseProvider(NoiseProvider)}}
*
* @param noiseProvider the noise provider
*/
public void setNoiseProvider(NoiseProvider noiseProvider) {
nature.setNoiseProvider(noiseProvider);
Expand All @@ -116,27 +128,35 @@ public void setRandom(Random random) {

/**
* see {@link MouseMotionNature#getMouseInfo()}
*
* @return the mouseInfo
*/
public MouseInfoAccessor getMouseInfo() {
return nature.getMouseInfo();
}

/**
* see {@link MouseMotionNature#setMouseInfo(MouseInfoAccessor)}
*
* @param mouseInfo the mouseInfo
*/
public void setMouseInfo(MouseInfoAccessor mouseInfo) {
nature.setMouseInfo(mouseInfo);
}

/**
* see {@link MouseMotionNature#getSpeedManager()}
*
* @return the manager
*/
public SpeedManager getSpeedManager() {
return nature.getSpeedManager();
}

/**
* see {@link MouseMotionNature#setSpeedManager(SpeedManager)}
*
* @param speedManager the manager
*/
public void setSpeedManager(SpeedManager speedManager) {
nature.setSpeedManager(speedManager);
Expand All @@ -162,13 +182,17 @@ public void setNature(MouseMotionNature nature) {

/**
* see {@link MouseMotionNature#setOvershootManager(OvershootManager)}
*
* @param manager the manager
*/
public void setOvershootManager(OvershootManager manager) {
nature.setOvershootManager(manager);
}

/**
* see {@link MouseMotionNature#getOvershootManager()}
*
* @return the manager
*/
public OvershootManager getOvershootManager() {
return nature.getOvershootManager();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ public interface OvershootManager {
/**
* Get the maximum amount of overshoots the cursor does before reaching its final destination.
* @param flow the flow which is planned to be used to reach the target.
* (If returned overshoots > 0, then a new flow will be calculated for each overshoot.).
* (If returned overshoots > 0, then a new flow will be calculated for each overshoot.).
* This flow could be analyzed if overshooting is suitable. It is not available
* as a parameter in overshootAmount calculation, because flow itself is calculated
* from the movement distance, which is dependent on the overshoot amount.
Expand All @@ -30,7 +30,7 @@ public interface OvershootManager {
* @param distanceToRealTargetY distance to real target Y-coordinate
* @param mouseMovementMs the time planned for reaching the real target
* @param overshootsRemaining the amount of overshoots remaining, current included.
* Values from (n to 1), where n >= 1
* Values from (n to 1), where n >= 1
* @return the amount which will be added to real target, thus getting the overshoot target.
*/
Point getOvershootAmount(double distanceToRealTargetX, double distanceToRealTargetY, long mouseMovementMs, int overshootsRemaining);
Expand All @@ -40,7 +40,7 @@ public interface OvershootManager {
* (can be real or overshoot target, if the next target is real target, the overshootsRemaining value is 0)
* @param mouseMovementMs the last mouse movement in ms
* @param overshootsRemaining the amount of overshoots remaining, including this.
* Values from (n to 0), where n >= 0
* Values from (n to 0), where n >= 0
* @return the next mouse movement time in ms
*/
long deriveNextMouseMovementTimeMs(long mouseMovementMs, int overshootsRemaining);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -167,7 +167,7 @@ public MouseInfoAccessor getMouseInfo() {
/**
* Set the accessor object, which MouseMotion uses to detect the position of mouse on screen.
*
* @param mouseInfo
* @param mouseInfo the accessor object
*/
public void setMouseInfo(MouseInfoAccessor mouseInfo) {
this.mouseInfo = mouseInfo;
Expand Down

0 comments on commit 0f38653

Please sign in to comment.