From 0ce68ee21f744d6c5ccf4339f0643c18b4b1576a Mon Sep 17 00:00:00 2001 From: Brady Date: Sun, 16 Sep 2018 15:28:23 -0500 Subject: [PATCH] Replace some issue references with proper javadocs where applicable --- src/main/java/baritone/Settings.java | 6 ++++-- .../baritone/pathing/calc/AbstractNodeCostSearch.java | 8 ++++++-- src/main/java/baritone/pathing/path/PathExecutor.java | 11 ++++++++++- 3 files changed, 20 insertions(+), 5 deletions(-) diff --git a/src/main/java/baritone/Settings.java b/src/main/java/baritone/Settings.java index bfbbec61..48dd17d8 100644 --- a/src/main/java/baritone/Settings.java +++ b/src/main/java/baritone/Settings.java @@ -139,8 +139,9 @@ public class Settings { public Setting pathingMaxChunkBorderFetch = new Setting<>(50); /** - * See issue #18 * Set to 1.0 to effectively disable this feature + * + * @see Issue #18 */ public Setting backtrackCostFavoringCoefficient = new Setting<>(0.9); @@ -153,7 +154,8 @@ public class Settings { /** * After calculating a path (potentially through cached chunks), artificially cut it off to just the part that is * entirely within currently loaded chunks. Improves path safety because cached chunks are heavily simplified. - * See issue #114 for why this is disabled. + * + * @see Issue #144 */ public Setting cutoffAtLoadBoundary = new Setting<>(false); diff --git a/src/main/java/baritone/pathing/calc/AbstractNodeCostSearch.java b/src/main/java/baritone/pathing/calc/AbstractNodeCostSearch.java index 3b8bfade..f4d90986 100644 --- a/src/main/java/baritone/pathing/calc/AbstractNodeCostSearch.java +++ b/src/main/java/baritone/pathing/calc/AbstractNodeCostSearch.java @@ -42,7 +42,10 @@ public abstract class AbstractNodeCostSearch implements IPathFinder { protected final Goal goal; - private final Long2ObjectOpenHashMap map; // see issue #107 + /** + * @see Issue #107 + */ + private final Long2ObjectOpenHashMap map; protected PathNode startNode; @@ -119,11 +122,12 @@ public abstract class AbstractNodeCostSearch implements IPathFinder { * for the node mapped to the specified pos. If no node is found, * a new node is created. * + * @see Issue #107 + * * @param pos The pos to lookup * @return The associated node */ protected PathNode getNodeAtPosition(BetterBlockPos pos) { - // see issue #107 long hashCode = pos.hashCode; PathNode node = map.get(hashCode); if (node == null) { diff --git a/src/main/java/baritone/pathing/path/PathExecutor.java b/src/main/java/baritone/pathing/path/PathExecutor.java index 8783ceb8..9db754ae 100644 --- a/src/main/java/baritone/pathing/path/PathExecutor.java +++ b/src/main/java/baritone/pathing/path/PathExecutor.java @@ -44,7 +44,16 @@ import static baritone.pathing.movement.MovementState.MovementStatus.*; public class PathExecutor implements Helper { private static final double MAX_MAX_DIST_FROM_PATH = 3; private static final double MAX_DIST_FROM_PATH = 2; - private static final double MAX_TICKS_AWAY = 200; // ten seconds. ok to decrease this, but it must be at least 110, see issue #102 + + /** + * Default value is equal to 10 seconds. It's find to decrease it, but it must be at least 5.5s (110 ticks). + * For more information, see issue #102. + * + * @see Issue #102 + * @see Anime + */ + private static final double MAX_TICKS_AWAY = 200; + private final IPath path; private int pathPosition; private int ticksAway;