From 0bce801a3f97821d9a40b738823d121173dca649 Mon Sep 17 00:00:00 2001
From: Brady <zeromemesdev@gmail.com>
Date: Sat, 23 Feb 2019 14:32:10 -0600
Subject: [PATCH] Minor javadoc changes

---
 src/api/java/baritone/api/BaritoneAPI.java    |  4 +-
 src/api/java/baritone/api/IBaritone.java      | 84 ++++++++++++-------
 .../java/baritone/api/IBaritoneProvider.java  |  7 +-
 src/api/java/baritone/api/Settings.java       |  2 +-
 .../java/baritone/api/behavior/IBehavior.java |  5 ++
 5 files changed, 67 insertions(+), 35 deletions(-)

diff --git a/src/api/java/baritone/api/BaritoneAPI.java b/src/api/java/baritone/api/BaritoneAPI.java
index c1227830..4ea6ef3e 100644
--- a/src/api/java/baritone/api/BaritoneAPI.java
+++ b/src/api/java/baritone/api/BaritoneAPI.java
@@ -23,9 +23,7 @@ import java.util.Iterator;
 import java.util.ServiceLoader;
 
 /**
- * API exposure for various things implemented in Baritone.
- * <p>
- * W.I.P
+ * Exposes the {@link IBaritoneProvider} instance and the {@link Settings} instance for API usage.
  *
  * @author Brady
  * @since 9/23/2018
diff --git a/src/api/java/baritone/api/IBaritone.java b/src/api/java/baritone/api/IBaritone.java
index 21157eb1..e88f600e 100644
--- a/src/api/java/baritone/api/IBaritone.java
+++ b/src/api/java/baritone/api/IBaritone.java
@@ -22,10 +22,7 @@ import baritone.api.behavior.IPathingBehavior;
 import baritone.api.cache.IWorldProvider;
 import baritone.api.event.listener.IEventBus;
 import baritone.api.pathing.calc.IPathingControlManager;
-import baritone.api.process.ICustomGoalProcess;
-import baritone.api.process.IFollowProcess;
-import baritone.api.process.IGetToBlockProcess;
-import baritone.api.process.IMineProcess;
+import baritone.api.process.*;
 import baritone.api.utils.IInputOverrideHandler;
 import baritone.api.utils.IPlayerContext;
 
@@ -36,22 +33,13 @@ import baritone.api.utils.IPlayerContext;
 public interface IBaritone {
 
     /**
-     * @return The {@link IFollowProcess} instance
-     * @see IFollowProcess
+     * Call as soon as Minecraft is ready, initializes all of the processes, behaviors, etc. This will
+     * only effectively be ran once, any additional calls are redundant because the initialization state
+     * is saved.
+     * <p>
+     * Or whenever your overeager utility client wants.
      */
-    IFollowProcess getFollowProcess();
-
-    /**
-     * @return The {@link ILookBehavior} instance
-     * @see ILookBehavior
-     */
-    ILookBehavior getLookBehavior();
-
-    /**
-     * @return The {@link IMineProcess} instance
-     * @see IMineProcess
-     */
-    IMineProcess getMineProcess();
+    void init();
 
     /**
      * @return The {@link IPathingBehavior} instance
@@ -59,28 +47,66 @@ public interface IBaritone {
      */
     IPathingBehavior getPathingBehavior();
 
+    /**
+     * @return The {@link ILookBehavior} instance
+     * @see ILookBehavior
+     */
+    ILookBehavior getLookBehavior();
+
+    /**
+     * @return The {@link IFollowProcess} instance
+     * @see IFollowProcess
+     */
+    IFollowProcess getFollowProcess();
+
+    /**
+     * @return The {@link IMineProcess} instance
+     * @see IMineProcess
+     */
+    IMineProcess getMineProcess();
+
+    /**
+     * @return The {@link ICustomGoalProcess} instance
+     * @see ICustomGoalProcess
+     */
+    ICustomGoalProcess getCustomGoalProcess();
+
+    /**
+     * @return The {@link IGetToBlockProcess} instance
+     * @see IGetToBlockProcess
+     */
+    IGetToBlockProcess getGetToBlockProcess();
+
     /**
      * @return The {@link IWorldProvider} instance
      * @see IWorldProvider
      */
     IWorldProvider getWorldProvider();
 
+    /**
+     * Returns the {@link IPathingControlManager} for this {@link IBaritone} instance, which is responsible
+     * for managing the {@link IBaritoneProcess}es which control the {@link IPathingBehavior} state.
+     *
+     * @return The {@link IPathingControlManager} instance
+     * @see IPathingControlManager
+     */
     IPathingControlManager getPathingControlManager();
 
+    /**
+     * @return The {@link IInputOverrideHandler} instance
+     * @see IInputOverrideHandler
+     */
     IInputOverrideHandler getInputOverrideHandler();
 
-    ICustomGoalProcess getCustomGoalProcess();
-
-    IGetToBlockProcess getGetToBlockProcess();
-
+    /**
+     * @return The {@link IPlayerContext} instance
+     * @see IPlayerContext
+     */
     IPlayerContext getPlayerContext();
 
-    IEventBus getGameEventHandler();
-
     /**
-     * Call as soon as Minecraft is ready.
-     * <p>
-     * Or whenever your overeager utility client wants.
+     * @return The {@link IEventBus} instance
+     * @see IEventBus
      */
-    void init();
+    IEventBus getGameEventHandler();
 }
diff --git a/src/api/java/baritone/api/IBaritoneProvider.java b/src/api/java/baritone/api/IBaritoneProvider.java
index d17e8e00..34a3aa21 100644
--- a/src/api/java/baritone/api/IBaritoneProvider.java
+++ b/src/api/java/baritone/api/IBaritoneProvider.java
@@ -23,7 +23,9 @@ import net.minecraft.client.entity.EntityPlayerSP;
 import java.util.List;
 
 /**
- * @author Leijurv
+ * Provides the present {@link IBaritone} instances
+ *
+ * @author leijurv
  */
 public interface IBaritoneProvider {
 
@@ -47,7 +49,8 @@ public interface IBaritoneProvider {
 
     /**
      * Provides the {@link IBaritone} instance for a given {@link EntityPlayerSP}. This will likely be
-     * replaced with {@code #getBaritoneForUser(IBaritoneUser)} when {@code bot-system} is merged.
+     * replaced with or be overloaded in addition to {@code #getBaritoneForUser(IBaritoneUser)} when
+     * {@code bot-system} is merged into {@code master}.
      *
      * @param player The player
      * @return The {@link IBaritone} instance.
diff --git a/src/api/java/baritone/api/Settings.java b/src/api/java/baritone/api/Settings.java
index 2879ba78..2d67dbe3 100644
--- a/src/api/java/baritone/api/Settings.java
+++ b/src/api/java/baritone/api/Settings.java
@@ -30,7 +30,7 @@ import java.util.List;
 import java.util.function.Consumer;
 
 /**
- * Baritone's settings
+ * Baritone's settings. Settings apply to all Baritone instances.
  *
  * @author leijurv
  */
diff --git a/src/api/java/baritone/api/behavior/IBehavior.java b/src/api/java/baritone/api/behavior/IBehavior.java
index 248148e7..fbef5258 100644
--- a/src/api/java/baritone/api/behavior/IBehavior.java
+++ b/src/api/java/baritone/api/behavior/IBehavior.java
@@ -18,8 +18,13 @@
 package baritone.api.behavior;
 
 import baritone.api.event.listener.AbstractGameEventListener;
+import baritone.api.event.listener.IGameEventListener;
 
 /**
+ * A behavior is simply a type that is able to listen to events.
+ *
+ * @see IGameEventListener
+ *
  * @author Brady
  * @since 9/23/2018
  */