Replace some issue references with proper javadocs where applicable

This commit is contained in:
Brady 2018-09-16 15:28:23 -05:00
parent 30fc72a34c
commit 0ce68ee21f
No known key found for this signature in database
GPG Key ID: 73A788379A197567
3 changed files with 20 additions and 5 deletions

View File

@ -139,8 +139,9 @@ public class Settings {
public Setting<Integer> pathingMaxChunkBorderFetch = new Setting<>(50);
/**
* See issue #18
* Set to 1.0 to effectively disable this feature
*
* @see <a href="https://github.com/cabaletta/baritone/issues/18">Issue #18</a>
*/
public Setting<Double> 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 <a href="https://github.com/cabaletta/baritone/issues/144">Issue #144</a>
*/
public Setting<Boolean> cutoffAtLoadBoundary = new Setting<>(false);

View File

@ -42,7 +42,10 @@ public abstract class AbstractNodeCostSearch implements IPathFinder {
protected final Goal goal;
private final Long2ObjectOpenHashMap<PathNode> map; // see issue #107
/**
* @see <a href="https://github.com/cabaletta/baritone/issues/107">Issue #107</a>
*/
private final Long2ObjectOpenHashMap<PathNode> 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 <a href="https://github.com/cabaletta/baritone/issues/107">Issue #107</a>
*
* @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) {

View File

@ -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 <a href="https://github.com/cabaletta/baritone/issues/102">Issue #102</a>
* @see <a href="https://i.imgur.com/5s5GLnI.png">Anime</a>
*/
private static final double MAX_TICKS_AWAY = 200;
private final IPath path;
private int pathPosition;
private int ticksAway;