Skip to content

Commit 4eb8485

Browse files
committed
fix javadoc
1 parent bfc5ca2 commit 4eb8485

2 files changed

Lines changed: 5 additions & 3 deletions

File tree

src/main/java/com/github/joonasvali/naturalmouse/api/DeviationProvider.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,7 @@ public interface DeviationProvider {
1717
* Point is added to single trajectory point and it will not have any effect in the next
1818
* mouse movement step, making it easy to implement this as a formula based on the input parameters.
1919
* e.g the something like 'deviation = totalDistanceInPixels / completionFraction', resulting in smooth movement.
20-
* (Don't actually use this formula), 'Noise' from the {@link (com.github.joonasvali.naturalmouse.api.NoiseProvider)}
21-
* is generating an offset from the original trajectory and is accumulating.
20+
* (Don't actually use this formula), 'Noise' is generating an offset from the original trajectory and is accumulating.
2221
*
2322
* As deviation should be deterministic and return same result for same parameters, it should not include Random
2423
* behaviour, thus Random is not included as a parameter.
@@ -32,6 +31,7 @@ public interface DeviationProvider {
3231
* target and initial position. This is not the final deviation of the mouse as MouseMotion will randomly decide
3332
* to either amplify or decrease it over the whole mouse movement, making the resulting arc stand out more or less,
3433
* or is flipped negatively.
34+
* @see com.github.joonasvali.naturalmouse.api.NoiseProvider
3535
*/
3636
DoublePoint getDeviation(double totalDistanceInPixels, double completionFraction);
3737
}

src/main/java/com/github/joonasvali/naturalmouse/api/NoiseProvider.java

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ public interface NoiseProvider {
1616
* Noise is accumulating, so on average it should create an equal chance of either positive or negative movement
1717
* on each axis, otherwise the mouse movement will always be slightly offset to single direction.
1818
*
19-
* Deviation from {@link (com.github.joonasvali.naturalmouse.api.DeviationProvider)} is different from the Noise
19+
* Deviation from DeviationProvider is different from the Noise
2020
* because it works like a mathematical function and is not accumulating.
2121
*
2222
* 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 {
3131
* @return a point which describes how much the mouse offset is increased or decreased this step.
3232
* This value must not include the parameters xStepSize and yStepSize. For no change in noise just return (0,0).
3333
*
34+
* @see com.github.joonasvali.naturalmouse.api.DeviationProvider
35+
*
3436
*/
3537
DoublePoint getNoise(Random random, double xStepSize, double yStepSize);
3638
}

0 commit comments

Comments
 (0)