From 0f386536aef4fe7a85c0175b7255cc68624998ff Mon Sep 17 00:00:00 2001 From: Joonas Vali Date: Sun, 10 Feb 2019 18:13:28 +0200 Subject: [PATCH] obligatory javadoc fixes for release --- .../naturalmouse/api/MouseMotionFactory.java | 24 +++++++++++++++++++ .../naturalmouse/api/OvershootManager.java | 6 ++--- .../support/MouseMotionNature.java | 2 +- 3 files changed, 28 insertions(+), 4 deletions(-) diff --git a/src/main/java/com/github/joonasvali/naturalmouse/api/MouseMotionFactory.java b/src/main/java/com/github/joonasvali/naturalmouse/api/MouseMotionFactory.java index cca4f6d..d46d605 100644 --- a/src/main/java/com/github/joonasvali/naturalmouse/api/MouseMotionFactory.java +++ b/src/main/java/com/github/joonasvali/naturalmouse/api/MouseMotionFactory.java @@ -56,6 +56,8 @@ public static MouseMotionFactory getDefault() { /** * see {@link MouseMotionNature#getSystemCalls()} + * + * @return the systemcalls */ public SystemCalls getSystemCalls() { return nature.getSystemCalls(); @@ -63,6 +65,8 @@ public SystemCalls getSystemCalls() { /** * see {@link MouseMotionNature#setSystemCalls(SystemCalls)} + * + * @param systemCalls the systemcalls */ public void setSystemCalls(SystemCalls systemCalls) { nature.setSystemCalls(systemCalls); @@ -70,6 +74,8 @@ public void setSystemCalls(SystemCalls systemCalls) { /** * see {@link MouseMotionNature#getDeviationProvider()} + * + * @return the deviation provider */ public DeviationProvider getDeviationProvider() { return nature.getDeviationProvider(); @@ -77,6 +83,8 @@ public DeviationProvider getDeviationProvider() { /** * see {@link MouseMotionNature#setDeviationProvider(DeviationProvider)} + * + * @param deviationProvider the deviation provider */ public void setDeviationProvider(DeviationProvider deviationProvider) { nature.setDeviationProvider(deviationProvider); @@ -84,6 +92,8 @@ public void setDeviationProvider(DeviationProvider deviationProvider) { /** * see {@link MouseMotionNature#getNoiseProvider()} + * + * @return the noise provider */ public NoiseProvider getNoiseProvider() { return nature.getNoiseProvider(); @@ -91,6 +101,8 @@ public NoiseProvider getNoiseProvider() { /** * see {@link MouseMotionNature#setNoiseProvider(NoiseProvider)}} + * + * @param noiseProvider the noise provider */ public void setNoiseProvider(NoiseProvider noiseProvider) { nature.setNoiseProvider(noiseProvider); @@ -116,6 +128,8 @@ public void setRandom(Random random) { /** * see {@link MouseMotionNature#getMouseInfo()} + * + * @return the mouseInfo */ public MouseInfoAccessor getMouseInfo() { return nature.getMouseInfo(); @@ -123,6 +137,8 @@ public MouseInfoAccessor getMouseInfo() { /** * see {@link MouseMotionNature#setMouseInfo(MouseInfoAccessor)} + * + * @param mouseInfo the mouseInfo */ public void setMouseInfo(MouseInfoAccessor mouseInfo) { nature.setMouseInfo(mouseInfo); @@ -130,6 +146,8 @@ public void setMouseInfo(MouseInfoAccessor mouseInfo) { /** * see {@link MouseMotionNature#getSpeedManager()} + * + * @return the manager */ public SpeedManager getSpeedManager() { return nature.getSpeedManager(); @@ -137,6 +155,8 @@ public SpeedManager getSpeedManager() { /** * see {@link MouseMotionNature#setSpeedManager(SpeedManager)} + * + * @param speedManager the manager */ public void setSpeedManager(SpeedManager speedManager) { nature.setSpeedManager(speedManager); @@ -162,6 +182,8 @@ public void setNature(MouseMotionNature nature) { /** * see {@link MouseMotionNature#setOvershootManager(OvershootManager)} + * + * @param manager the manager */ public void setOvershootManager(OvershootManager manager) { nature.setOvershootManager(manager); @@ -169,6 +191,8 @@ public void setOvershootManager(OvershootManager manager) { /** * see {@link MouseMotionNature#getOvershootManager()} + * + * @return the manager */ public OvershootManager getOvershootManager() { return nature.getOvershootManager(); diff --git a/src/main/java/com/github/joonasvali/naturalmouse/api/OvershootManager.java b/src/main/java/com/github/joonasvali/naturalmouse/api/OvershootManager.java index b747660..5a079bf 100644 --- a/src/main/java/com/github/joonasvali/naturalmouse/api/OvershootManager.java +++ b/src/main/java/com/github/joonasvali/naturalmouse/api/OvershootManager.java @@ -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. @@ -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); @@ -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); diff --git a/src/main/java/com/github/joonasvali/naturalmouse/support/MouseMotionNature.java b/src/main/java/com/github/joonasvali/naturalmouse/support/MouseMotionNature.java index 6d0350d..0d9deab 100644 --- a/src/main/java/com/github/joonasvali/naturalmouse/support/MouseMotionNature.java +++ b/src/main/java/com/github/joonasvali/naturalmouse/support/MouseMotionNature.java @@ -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;