From 4eb84854f2a7bd16cbc459eb67ffe89d83cc9517 Mon Sep 17 00:00:00 2001 From: Joonas Vali Date: Sun, 28 Apr 2019 12:02:46 +0300 Subject: [PATCH] fix javadoc --- .../github/joonasvali/naturalmouse/api/DeviationProvider.java | 4 ++-- .../com/github/joonasvali/naturalmouse/api/NoiseProvider.java | 4 +++- 2 files changed, 5 insertions(+), 3 deletions(-) diff --git a/src/main/java/com/github/joonasvali/naturalmouse/api/DeviationProvider.java b/src/main/java/com/github/joonasvali/naturalmouse/api/DeviationProvider.java index cf2ffd1..09acf4f 100644 --- a/src/main/java/com/github/joonasvali/naturalmouse/api/DeviationProvider.java +++ b/src/main/java/com/github/joonasvali/naturalmouse/api/DeviationProvider.java @@ -17,8 +17,7 @@ public interface DeviationProvider { * Point is added to single trajectory point and it will not have any effect in the next * mouse movement step, making it easy to implement this as a formula based on the input parameters. * e.g the something like 'deviation = totalDistanceInPixels / completionFraction', resulting in smooth movement. - * (Don't actually use this formula), 'Noise' from the {@link (com.github.joonasvali.naturalmouse.api.NoiseProvider)} - * is generating an offset from the original trajectory and is accumulating. + * (Don't actually use this formula), 'Noise' is generating an offset from the original trajectory and is accumulating. * * As deviation should be deterministic and return same result for same parameters, it should not include Random * behaviour, thus Random is not included as a parameter. @@ -32,6 +31,7 @@ public interface DeviationProvider { * target and initial position. This is not the final deviation of the mouse as MouseMotion will randomly decide * to either amplify or decrease it over the whole mouse movement, making the resulting arc stand out more or less, * or is flipped negatively. + * @see com.github.joonasvali.naturalmouse.api.NoiseProvider */ DoublePoint getDeviation(double totalDistanceInPixels, double completionFraction); } diff --git a/src/main/java/com/github/joonasvali/naturalmouse/api/NoiseProvider.java b/src/main/java/com/github/joonasvali/naturalmouse/api/NoiseProvider.java index a6cc867..23ffccc 100644 --- a/src/main/java/com/github/joonasvali/naturalmouse/api/NoiseProvider.java +++ b/src/main/java/com/github/joonasvali/naturalmouse/api/NoiseProvider.java @@ -16,7 +16,7 @@ public interface NoiseProvider { * Noise is accumulating, so on average it should create an equal chance of either positive or negative movement * on each axis, otherwise the mouse movement will always be slightly offset to single direction. * - * Deviation from {@link (com.github.joonasvali.naturalmouse.api.DeviationProvider)} is different from the Noise + * Deviation from DeviationProvider is different from the Noise * because it works like a mathematical function and is not accumulating. * * Not every step needs to add noise, use randomness to only add noise sometimes, otherwise return Point(0, 0). @@ -31,6 +31,8 @@ public interface NoiseProvider { * @return a point which describes how much the mouse offset is increased or decreased this step. * This value must not include the parameters xStepSize and yStepSize. For no change in noise just return (0,0). * + * @see com.github.joonasvali.naturalmouse.api.DeviationProvider + * */ DoublePoint getNoise(Random random, double xStepSize, double yStepSize); }