diff --git a/parabotv2/src/org/parabot/core/Configuration.java b/parabotv2/src/org/parabot/core/Configuration.java index 3f86a49..a381c36 100644 --- a/parabotv2/src/org/parabot/core/Configuration.java +++ b/parabotv2/src/org/parabot/core/Configuration.java @@ -1,6 +1,8 @@ package org.parabot.core; /** + * + * Holds some important constants * * @author Everel * diff --git a/parabotv2/src/org/parabot/core/Core.java b/parabotv2/src/org/parabot/core/Core.java index 3c7dac7..94aad65 100644 --- a/parabotv2/src/org/parabot/core/Core.java +++ b/parabotv2/src/org/parabot/core/Core.java @@ -6,6 +6,8 @@ import java.io.BufferedReader; import java.io.IOException; /** + * + * The core of parabot * * @author Everel * diff --git a/parabotv2/src/org/parabot/core/Directories.java b/parabotv2/src/org/parabot/core/Directories.java index 6deaa7a..61934e0 100644 --- a/parabotv2/src/org/parabot/core/Directories.java +++ b/parabotv2/src/org/parabot/core/Directories.java @@ -12,6 +12,8 @@ import javax.swing.JFileChooser; import org.parabot.environment.OperatingSystem; /** + * + * Holds parabot's used directories * * @author Everel * @author Matt diff --git a/parabotv2/src/org/parabot/core/asm/ASMClassLoader.java b/parabotv2/src/org/parabot/core/asm/ASMClassLoader.java index 052952c..e998cfd 100644 --- a/parabotv2/src/org/parabot/core/asm/ASMClassLoader.java +++ b/parabotv2/src/org/parabot/core/asm/ASMClassLoader.java @@ -15,6 +15,8 @@ import org.objectweb.asm.tree.ClassNode; import org.parabot.core.classpath.ClassPath; /** + * + * Makes classnodes into runnable classes * * @author Everel * @author Matt diff --git a/parabotv2/src/org/parabot/core/asm/ASMUtils.java b/parabotv2/src/org/parabot/core/asm/ASMUtils.java index a71fc4f..aa62617 100644 --- a/parabotv2/src/org/parabot/core/asm/ASMUtils.java +++ b/parabotv2/src/org/parabot/core/asm/ASMUtils.java @@ -7,6 +7,8 @@ import org.objectweb.asm.tree.MethodNode; import org.parabot.core.Context; /** + * + * A collection of various asm util methods * * @author Everel * diff --git a/parabotv2/src/org/parabot/core/asm/adapters/AddInterfaceAdapter.java b/parabotv2/src/org/parabot/core/asm/adapters/AddInterfaceAdapter.java index a4ea32a..7dd2c74 100644 --- a/parabotv2/src/org/parabot/core/asm/adapters/AddInterfaceAdapter.java +++ b/parabotv2/src/org/parabot/core/asm/adapters/AddInterfaceAdapter.java @@ -6,6 +6,8 @@ import org.parabot.core.asm.ASMUtils; import org.parabot.core.asm.interfaces.Injectable; /** + * + * This class appends an interface to a class * * @author Everel * diff --git a/parabotv2/src/org/parabot/core/asm/adapters/AddSuperAdapter.java b/parabotv2/src/org/parabot/core/asm/adapters/AddSuperAdapter.java index 80889f9..169115d 100644 --- a/parabotv2/src/org/parabot/core/asm/adapters/AddSuperAdapter.java +++ b/parabotv2/src/org/parabot/core/asm/adapters/AddSuperAdapter.java @@ -12,6 +12,8 @@ import org.parabot.core.asm.ASMUtils; import org.parabot.core.asm.interfaces.Injectable; /** + * + * This class is used for changing the super class of a class * * @author Everel * diff --git a/parabotv2/src/org/parabot/core/asm/interfaces/Injectable.java b/parabotv2/src/org/parabot/core/asm/interfaces/Injectable.java index 593062c..a96f1a7 100644 --- a/parabotv2/src/org/parabot/core/asm/interfaces/Injectable.java +++ b/parabotv2/src/org/parabot/core/asm/interfaces/Injectable.java @@ -1,7 +1,15 @@ package org.parabot.core.asm.interfaces; +/** + * Injectable + * @author Everel + * + */ public interface Injectable { + /** + * Injects bytecode into a class + */ public void inject(); } diff --git a/parabotv2/src/org/parabot/core/asm/wrappers/Callback.java b/parabotv2/src/org/parabot/core/asm/wrappers/Callback.java index 2d658c3..f277a2f 100644 --- a/parabotv2/src/org/parabot/core/asm/wrappers/Callback.java +++ b/parabotv2/src/org/parabot/core/asm/wrappers/Callback.java @@ -6,6 +6,8 @@ import org.parabot.core.asm.adapters.AddCallbackAdapter; import org.parabot.core.asm.interfaces.Injectable; /** + * + * This class is used for injecting a callback into a methodnode * * @author Everel * diff --git a/parabotv2/src/org/parabot/core/asm/wrappers/Getter.java b/parabotv2/src/org/parabot/core/asm/wrappers/Getter.java index fa93b2e..5eb78b5 100644 --- a/parabotv2/src/org/parabot/core/asm/wrappers/Getter.java +++ b/parabotv2/src/org/parabot/core/asm/wrappers/Getter.java @@ -7,6 +7,8 @@ import org.parabot.core.asm.adapters.AddGetterAdapter; import org.parabot.core.asm.interfaces.Injectable; /** + * + * This class injects a getter which gets a specific field * * @author Everel * diff --git a/parabotv2/src/org/parabot/core/asm/wrappers/Interface.java b/parabotv2/src/org/parabot/core/asm/wrappers/Interface.java index 26a631c..4df0b0c 100644 --- a/parabotv2/src/org/parabot/core/asm/wrappers/Interface.java +++ b/parabotv2/src/org/parabot/core/asm/wrappers/Interface.java @@ -4,6 +4,8 @@ import org.parabot.core.asm.adapters.AddInterfaceAdapter; import org.parabot.core.asm.interfaces.Injectable; /** + * + * This class appends an interface to a class * * @author Everel * diff --git a/parabotv2/src/org/parabot/core/asm/wrappers/Invoker.java b/parabotv2/src/org/parabot/core/asm/wrappers/Invoker.java index 9bf9cd3..52c2e39 100644 --- a/parabotv2/src/org/parabot/core/asm/wrappers/Invoker.java +++ b/parabotv2/src/org/parabot/core/asm/wrappers/Invoker.java @@ -7,6 +7,8 @@ import org.parabot.core.asm.adapters.AddInvokerAdapter; import org.parabot.core.asm.interfaces.Injectable; /** + * + * This class is used for injecting an invoker into a methodnode * * @author Everel * diff --git a/parabotv2/src/org/parabot/core/asm/wrappers/Setter.java b/parabotv2/src/org/parabot/core/asm/wrappers/Setter.java index 1483350..29895a7 100644 --- a/parabotv2/src/org/parabot/core/asm/wrappers/Setter.java +++ b/parabotv2/src/org/parabot/core/asm/wrappers/Setter.java @@ -7,6 +7,8 @@ import org.parabot.core.asm.adapters.AddSetterAdapter; import org.parabot.core.asm.interfaces.Injectable; /** + * + * This class is used for injecting a setter for a specific field * * @author Everel * diff --git a/parabotv2/src/org/parabot/core/asm/wrappers/Super.java b/parabotv2/src/org/parabot/core/asm/wrappers/Super.java index f452f5e..fbc6751 100644 --- a/parabotv2/src/org/parabot/core/asm/wrappers/Super.java +++ b/parabotv2/src/org/parabot/core/asm/wrappers/Super.java @@ -3,6 +3,8 @@ package org.parabot.core.asm.wrappers; import org.parabot.core.asm.adapters.AddSuperAdapter; import org.parabot.core.asm.interfaces.Injectable; /** + * + * This class is used for changing the super class of a class * * @author Everel * diff --git a/parabotv2/src/org/parabot/core/build/BuildPath.java b/parabotv2/src/org/parabot/core/build/BuildPath.java index 11d31d3..b80e78e 100644 --- a/parabotv2/src/org/parabot/core/build/BuildPath.java +++ b/parabotv2/src/org/parabot/core/build/BuildPath.java @@ -5,6 +5,8 @@ import java.net.URL; import java.net.URLClassLoader; /** + * + * Class used for adding urls to the buildpath * * @author Everel * diff --git a/parabotv2/src/org/parabot/core/classpath/ClassPath.java b/parabotv2/src/org/parabot/core/classpath/ClassPath.java index 4af6ee5..e444eeb 100644 --- a/parabotv2/src/org/parabot/core/classpath/ClassPath.java +++ b/parabotv2/src/org/parabot/core/classpath/ClassPath.java @@ -27,6 +27,8 @@ import org.parabot.core.io.SizeInputStream; import org.parabot.core.ui.components.VerboseLoader; /** + * + * Manages, parses and dumps class files & jars * * @author Everel * @author Matt diff --git a/parabotv2/src/org/parabot/core/desc/ServerDescription.java b/parabotv2/src/org/parabot/core/desc/ServerDescription.java index 74e899a..5fb92b6 100644 --- a/parabotv2/src/org/parabot/core/desc/ServerDescription.java +++ b/parabotv2/src/org/parabot/core/desc/ServerDescription.java @@ -1,6 +1,8 @@ package org.parabot.core.desc; /** + * + * Holds information about a server * * @author Everel * diff --git a/parabotv2/src/org/parabot/core/forum/AccountManagerAccess.java b/parabotv2/src/org/parabot/core/forum/AccountManagerAccess.java index 76e19ac..262b068 100644 --- a/parabotv2/src/org/parabot/core/forum/AccountManagerAccess.java +++ b/parabotv2/src/org/parabot/core/forum/AccountManagerAccess.java @@ -1,5 +1,12 @@ package org.parabot.core.forum; +/** + * + * Gives access to account details + * + * @author Everel + * + */ public interface AccountManagerAccess { public void setManager(AccountManager manager); diff --git a/parabotv2/src/org/parabot/core/io/ProgressListener.java b/parabotv2/src/org/parabot/core/io/ProgressListener.java index 130c0b4..c899031 100644 --- a/parabotv2/src/org/parabot/core/io/ProgressListener.java +++ b/parabotv2/src/org/parabot/core/io/ProgressListener.java @@ -1,9 +1,24 @@ package org.parabot.core.io; +/** + * + * Keeps track of a progress + * + * @author Everel + * + */ public interface ProgressListener { + /** + * Called when progress increased + * @param value + */ public void onProgressUpdate(double value); + /** + * Updates upload speed + * @param mbPerSecond + */ public void updateDownloadSpeed(double mbPerSecond); } diff --git a/parabotv2/src/org/parabot/core/jython/Jython.java b/parabotv2/src/org/parabot/core/jython/Jython.java index a5c0287..79e2b65 100644 --- a/parabotv2/src/org/parabot/core/jython/Jython.java +++ b/parabotv2/src/org/parabot/core/jython/Jython.java @@ -8,6 +8,8 @@ import org.parabot.core.Directories; import org.parabot.core.build.BuildPath; /** + * + * Jython util class * * @author Everel * diff --git a/parabotv2/src/org/parabot/core/paint/AbstractDebugger.java b/parabotv2/src/org/parabot/core/paint/AbstractDebugger.java index 70bea25..548c69f 100644 --- a/parabotv2/src/org/parabot/core/paint/AbstractDebugger.java +++ b/parabotv2/src/org/parabot/core/paint/AbstractDebugger.java @@ -2,10 +2,24 @@ package org.parabot.core.paint; import org.parabot.environment.api.interfaces.Paintable; +/** + * + * Abstract class for debugging in game values & more + * + * @author Everel + * + */ public abstract class AbstractDebugger implements Paintable { + /** + * Toggles this debugger + */ public abstract void toggle(); + /** + * + * @return true if this debugger is enabled, otherwise false + */ public abstract boolean isEnabled(); } diff --git a/parabotv2/src/org/parabot/core/paint/PaintDebugger.java b/parabotv2/src/org/parabot/core/paint/PaintDebugger.java index 7453174..ef1cfb7 100644 --- a/parabotv2/src/org/parabot/core/paint/PaintDebugger.java +++ b/parabotv2/src/org/parabot/core/paint/PaintDebugger.java @@ -9,6 +9,8 @@ import java.util.Queue; import org.parabot.core.Context; /** + * + * Manages and paints on a collection of AbstractDebuggers * * @author Everel * diff --git a/parabotv2/src/org/parabot/core/parsers/scripts/LocalJavaScripts.java b/parabotv2/src/org/parabot/core/parsers/scripts/LocalJavaScripts.java index 90dbee0..5368860 100644 --- a/parabotv2/src/org/parabot/core/parsers/scripts/LocalJavaScripts.java +++ b/parabotv2/src/org/parabot/core/parsers/scripts/LocalJavaScripts.java @@ -13,6 +13,8 @@ import org.parabot.environment.scripts.ScriptManifest; import org.parabot.environment.scripts.loader.JavaScriptLoader; /** + * + * Parses locally stored java scripts * * @author Everel * diff --git a/parabotv2/src/org/parabot/core/parsers/scripts/LocalPythonScripts.java b/parabotv2/src/org/parabot/core/parsers/scripts/LocalPythonScripts.java index edfc696..9475b79 100644 --- a/parabotv2/src/org/parabot/core/parsers/scripts/LocalPythonScripts.java +++ b/parabotv2/src/org/parabot/core/parsers/scripts/LocalPythonScripts.java @@ -14,7 +14,7 @@ import org.python.util.PythonInterpreter; /** * - * Parser python scripts + * Parses python scripts * * @author Everel * diff --git a/parabotv2/src/org/parabot/core/parsers/scripts/SDNScripts.java b/parabotv2/src/org/parabot/core/parsers/scripts/SDNScripts.java index 8db6d7c..99b9444 100644 --- a/parabotv2/src/org/parabot/core/parsers/scripts/SDNScripts.java +++ b/parabotv2/src/org/parabot/core/parsers/scripts/SDNScripts.java @@ -10,6 +10,8 @@ import org.parabot.environment.api.utils.WebUtil; import org.parabot.environment.scripts.SDNScriptExecuter; /** + * + * Parses scripts stored at parabotīs sdn * * @author Everel * diff --git a/parabotv2/src/org/parabot/core/parsers/scripts/ScriptParser.java b/parabotv2/src/org/parabot/core/parsers/scripts/ScriptParser.java index 03b62b1..ea0ad5b 100644 --- a/parabotv2/src/org/parabot/core/parsers/scripts/ScriptParser.java +++ b/parabotv2/src/org/parabot/core/parsers/scripts/ScriptParser.java @@ -10,6 +10,8 @@ import org.parabot.core.jython.Jython; import org.parabot.environment.scripts.ScriptExecuter; /** + * + * Abstract class for parsing scripts * * @author Everel * diff --git a/parabotv2/src/org/parabot/core/ui/BotUI.java b/parabotv2/src/org/parabot/core/ui/BotUI.java index bd9de69..692913a 100644 --- a/parabotv2/src/org/parabot/core/ui/BotUI.java +++ b/parabotv2/src/org/parabot/core/ui/BotUI.java @@ -13,6 +13,8 @@ import java.awt.event.ActionEvent; import java.awt.event.ActionListener; /** + * + * The bot user interface * * @author Dane, Everel * diff --git a/parabotv2/src/org/parabot/core/ui/LoginUI.java b/parabotv2/src/org/parabot/core/ui/LoginUI.java index 2b00817..59287e4 100644 --- a/parabotv2/src/org/parabot/core/ui/LoginUI.java +++ b/parabotv2/src/org/parabot/core/ui/LoginUI.java @@ -25,6 +25,8 @@ import org.parabot.core.ui.images.Images; import org.parabot.core.ui.utils.SwingUtil; /** + * + * Users must login with their parabot account through this LoginUI class * * @author Everel * diff --git a/parabotv2/src/org/parabot/core/ui/components/LogArea.java b/parabotv2/src/org/parabot/core/ui/components/LogArea.java index 32cc53d..4857aab 100644 --- a/parabotv2/src/org/parabot/core/ui/components/LogArea.java +++ b/parabotv2/src/org/parabot/core/ui/components/LogArea.java @@ -17,6 +17,8 @@ import org.parabot.core.logging.SystemConsoleHandler; import org.parabot.core.logging.TextAreaLogHandler; /** + * + * The LogArea of the BotUI * * @author Everel * diff --git a/parabotv2/src/org/parabot/core/ui/components/ProgressBar.java b/parabotv2/src/org/parabot/core/ui/components/ProgressBar.java index 8281cb4..75bcfa2 100644 --- a/parabotv2/src/org/parabot/core/ui/components/ProgressBar.java +++ b/parabotv2/src/org/parabot/core/ui/components/ProgressBar.java @@ -7,6 +7,8 @@ import java.awt.Graphics2D; import java.awt.geom.Rectangle2D; /** + * + * ProgressBar * * @author Everel * diff --git a/parabotv2/src/org/parabot/core/ui/components/ServerPanel.java b/parabotv2/src/org/parabot/core/ui/components/ServerPanel.java index 188345e..db48a92 100644 --- a/parabotv2/src/org/parabot/core/ui/components/ServerPanel.java +++ b/parabotv2/src/org/parabot/core/ui/components/ServerPanel.java @@ -8,6 +8,8 @@ import javax.swing.GroupLayout; import javax.swing.JPanel; /** + * + * Game Applet holder * * @author Everel * diff --git a/parabotv2/src/org/parabot/core/ui/images/Images.java b/parabotv2/src/org/parabot/core/ui/images/Images.java index 06af614..836f4d6 100644 --- a/parabotv2/src/org/parabot/core/ui/images/Images.java +++ b/parabotv2/src/org/parabot/core/ui/images/Images.java @@ -6,6 +6,8 @@ import java.util.HashMap; import javax.imageio.ImageIO; /** + * + * Caches and loads images from resource * * @author Everel * diff --git a/parabotv2/src/org/parabot/core/ui/utils/AwtUtil.java b/parabotv2/src/org/parabot/core/ui/utils/AwtUtil.java index 7624e15..fd2210f 100644 --- a/parabotv2/src/org/parabot/core/ui/utils/AwtUtil.java +++ b/parabotv2/src/org/parabot/core/ui/utils/AwtUtil.java @@ -4,6 +4,8 @@ import java.awt.Dimension; import java.awt.Toolkit; /** + * + * Holds various awt util based methods * * @author Dane * diff --git a/parabotv2/src/org/parabot/core/ui/utils/SwingUtil.java b/parabotv2/src/org/parabot/core/ui/utils/SwingUtil.java index c46d4ba..44cdb53 100644 --- a/parabotv2/src/org/parabot/core/ui/utils/SwingUtil.java +++ b/parabotv2/src/org/parabot/core/ui/utils/SwingUtil.java @@ -3,6 +3,8 @@ package org.parabot.core.ui.utils; import javax.swing.JFrame; /** + * + * Holds various swing util based methods * * @author Dane * diff --git a/parabotv2/src/org/parabot/core/ui/utils/UILog.java b/parabotv2/src/org/parabot/core/ui/utils/UILog.java index daed353..1a48176 100644 --- a/parabotv2/src/org/parabot/core/ui/utils/UILog.java +++ b/parabotv2/src/org/parabot/core/ui/utils/UILog.java @@ -3,6 +3,8 @@ package org.parabot.core.ui.utils; import javax.swing.JOptionPane; /** + * + * Log messages to the log user interface which is attached to the bot user interface * * @author Everel * diff --git a/parabotv2/src/org/parabot/core/ui/widgets/ServerWidget.java b/parabotv2/src/org/parabot/core/ui/widgets/ServerWidget.java index 5c10b2d..1100bfc 100644 --- a/parabotv2/src/org/parabot/core/ui/widgets/ServerWidget.java +++ b/parabotv2/src/org/parabot/core/ui/widgets/ServerWidget.java @@ -18,7 +18,7 @@ import org.parabot.core.ui.ServerSelector; import org.parabot.environment.Environment; /** - * A colorful server widget + * A neat looking server widget * * @author Everel * diff --git a/parabotv2/src/org/parabot/environment/Environment.java b/parabotv2/src/org/parabot/environment/Environment.java index fcf17bd..b9fb840 100644 --- a/parabotv2/src/org/parabot/environment/Environment.java +++ b/parabotv2/src/org/parabot/environment/Environment.java @@ -9,6 +9,8 @@ import org.parabot.core.ui.components.VerboseLoader; import org.parabot.environment.api.utils.WebUtil; /** + * + * Initiliazes the bot environment * * @author Everel * diff --git a/parabotv2/src/org/parabot/environment/OperatingSystem.java b/parabotv2/src/org/parabot/environment/OperatingSystem.java index be01756..c259d7d 100644 --- a/parabotv2/src/org/parabot/environment/OperatingSystem.java +++ b/parabotv2/src/org/parabot/environment/OperatingSystem.java @@ -1,5 +1,12 @@ package org.parabot.environment; +/** + * + * This class is used for detecting the user's operating system + * + * @author Everel + * + */ public enum OperatingSystem { WINDOWS, LINUX, MAC, OTHER; diff --git a/parabotv2/src/org/parabot/environment/api/utils/Filter.java b/parabotv2/src/org/parabot/environment/api/utils/Filter.java index 51aca83..bdcc981 100644 --- a/parabotv2/src/org/parabot/environment/api/utils/Filter.java +++ b/parabotv2/src/org/parabot/environment/api/utils/Filter.java @@ -1,14 +1,17 @@ package org.parabot.environment.api.utils; /** - * A simple class to filter things + * A simple class to filter things out of an collection * * @author Everel * * @param */ -public interface Filter -{ +public interface Filter { + /** + * Determines if this object should be accepted + * @param f + * @return true to include this object, otherwise false to exclude. + */ public boolean accept(F f); } - diff --git a/parabotv2/src/org/parabot/environment/api/utils/Random.java b/parabotv2/src/org/parabot/environment/api/utils/Random.java index b9cb9fe..804983c 100644 --- a/parabotv2/src/org/parabot/environment/api/utils/Random.java +++ b/parabotv2/src/org/parabot/environment/api/utils/Random.java @@ -1,6 +1,8 @@ package org.parabot.environment.api.utils; /** + * + * A random class is used for generating random numbers * * @author Everel * diff --git a/parabotv2/src/org/parabot/environment/api/utils/Time.java b/parabotv2/src/org/parabot/environment/api/utils/Time.java index d3570a8..777a475 100644 --- a/parabotv2/src/org/parabot/environment/api/utils/Time.java +++ b/parabotv2/src/org/parabot/environment/api/utils/Time.java @@ -1,6 +1,8 @@ package org.parabot.environment.api.utils; /** + * + * Holds various Time utilities * * @author Everel * diff --git a/parabotv2/src/org/parabot/environment/api/utils/Timer.java b/parabotv2/src/org/parabot/environment/api/utils/Timer.java index 19a0a0c..3aa2ced 100644 --- a/parabotv2/src/org/parabot/environment/api/utils/Timer.java +++ b/parabotv2/src/org/parabot/environment/api/utils/Timer.java @@ -7,8 +7,7 @@ package org.parabot.environment.api.utils; * @author Everel, Parameter * */ -public class Timer -{ +public class Timer { private long start; private long end; @@ -18,8 +17,7 @@ public class Timer * * @param start */ - public Timer(long end) - { + public Timer(long end) { start = System.currentTimeMillis(); this.end = System.currentTimeMillis() + end; @@ -28,8 +26,7 @@ public class Timer /** * Timer Constructor */ - public Timer() - { + public Timer() { this(0); } @@ -43,7 +40,8 @@ public class Timer } /** - * Determines if the end time has been reached, does not mean it stopped running. + * Determines if the end time has been reached, does not mean it stopped + * running. */ public boolean isFinished() { return System.currentTimeMillis() > end; diff --git a/parabotv2/src/org/parabot/environment/api/utils/WebUtil.java b/parabotv2/src/org/parabot/environment/api/utils/WebUtil.java index 00566b2..3d18e1d 100644 --- a/parabotv2/src/org/parabot/environment/api/utils/WebUtil.java +++ b/parabotv2/src/org/parabot/environment/api/utils/WebUtil.java @@ -15,6 +15,8 @@ import org.parabot.core.io.ProgressListener; import org.parabot.core.io.SizeInputStream; /** + * + * A WebUtil class fetches data from an URL * * @author Everel * diff --git a/parabotv2/src/org/parabot/environment/input/Keyboard.java b/parabotv2/src/org/parabot/environment/input/Keyboard.java index 1b258c1..72f9a45 100644 --- a/parabotv2/src/org/parabot/environment/input/Keyboard.java +++ b/parabotv2/src/org/parabot/environment/input/Keyboard.java @@ -9,6 +9,8 @@ import java.util.Random; import org.parabot.core.Context; /** + * + * Virtual keyboard, dispatches key events to a component. * * @author Everel, Matt, Dane * diff --git a/parabotv2/src/org/parabot/environment/input/Mouse.java b/parabotv2/src/org/parabot/environment/input/Mouse.java index bbd68c4..a69fd16 100644 --- a/parabotv2/src/org/parabot/environment/input/Mouse.java +++ b/parabotv2/src/org/parabot/environment/input/Mouse.java @@ -10,6 +10,8 @@ import org.parabot.core.Context; import org.parabot.environment.api.utils.Time; /** + * + * A virtual mouse, dispatches mouse events to a component * * @author Everel * diff --git a/parabotv2/src/org/parabot/environment/scripts/Category.java b/parabotv2/src/org/parabot/environment/scripts/Category.java index 158542b..30deb49 100644 --- a/parabotv2/src/org/parabot/environment/scripts/Category.java +++ b/parabotv2/src/org/parabot/environment/scripts/Category.java @@ -7,6 +7,8 @@ import org.parabot.core.ui.images.Images; /** + * + * Holds script categories * * @author Dane * @@ -16,10 +18,19 @@ public enum Category AGILITY, COMBAT, COOKING, CRAFTING, FARMING, FIREMAKING, FISHING, FLETCHING, HERBLORE, MAGIC, MINING, OTHER, PRAYER, RUNECRAFTING, SLAYER, SMITHING, THIEVING, UTILITY, WOODCUTTING; + /** + * Gets image belonging to this category + * @return icon + */ public BufferedImage getIcon() { return Category.getIcon(this.name().toLowerCase()); } + /** + * Gets category icon image from filename + * @param s + * @return icon + */ public static BufferedImage getIcon(String s) { if (images.get(s) == null) { images.put(s, Images.getResource("/org/parabot/core/ui/images/category/" + s + ".png")); @@ -35,6 +46,9 @@ public enum Category return new String(b); } + /** + * Cache + */ private static HashMap images = new HashMap(); static { diff --git a/parabotv2/src/org/parabot/environment/scripts/Frameworks.java b/parabotv2/src/org/parabot/environment/scripts/Frameworks.java index c762e78..0afaedd 100644 --- a/parabotv2/src/org/parabot/environment/scripts/Frameworks.java +++ b/parabotv2/src/org/parabot/environment/scripts/Frameworks.java @@ -7,6 +7,8 @@ import org.parabot.environment.scripts.framework.LoopTask; import org.parabot.environment.scripts.framework.Strategy; /** + * + * Holds various script frameworks * * @author Everel * diff --git a/parabotv2/src/org/parabot/environment/scripts/LocalScriptExecuter.java b/parabotv2/src/org/parabot/environment/scripts/LocalScriptExecuter.java index ac7c64b..bfb0823 100644 --- a/parabotv2/src/org/parabot/environment/scripts/LocalScriptExecuter.java +++ b/parabotv2/src/org/parabot/environment/scripts/LocalScriptExecuter.java @@ -1,6 +1,8 @@ package org.parabot.environment.scripts; /** + * + * Loads a locally stored script * * @author Everel * diff --git a/parabotv2/src/org/parabot/environment/scripts/SDNScriptExecuter.java b/parabotv2/src/org/parabot/environment/scripts/SDNScriptExecuter.java index 821d0e0..ea37123 100644 --- a/parabotv2/src/org/parabot/environment/scripts/SDNScriptExecuter.java +++ b/parabotv2/src/org/parabot/environment/scripts/SDNScriptExecuter.java @@ -15,6 +15,8 @@ import org.parabot.environment.api.utils.WebUtil; import org.parabot.environment.scripts.loader.JavaScriptLoader; /** + * + * Loads a script from the SDN * * @author Everel * diff --git a/parabotv2/src/org/parabot/environment/scripts/Script.java b/parabotv2/src/org/parabot/environment/scripts/Script.java index c3e40ad..dee3cdc 100644 --- a/parabotv2/src/org/parabot/environment/scripts/Script.java +++ b/parabotv2/src/org/parabot/environment/scripts/Script.java @@ -13,6 +13,8 @@ import org.parabot.environment.scripts.framework.SleepCondition; import org.parabot.environment.scripts.framework.Strategy; /** + * + * Script template, scripts are 'add-ons' which executes various tasks in-game * * @author Everel * diff --git a/parabotv2/src/org/parabot/environment/scripts/ScriptExecuter.java b/parabotv2/src/org/parabot/environment/scripts/ScriptExecuter.java index bfb2e8a..e97b283 100644 --- a/parabotv2/src/org/parabot/environment/scripts/ScriptExecuter.java +++ b/parabotv2/src/org/parabot/environment/scripts/ScriptExecuter.java @@ -1,9 +1,21 @@ package org.parabot.environment.scripts; +/** + * + * Executes a script + * + * @author Everel + * + */ public abstract class ScriptExecuter { public abstract void run(final ThreadGroup tg); + /** + * Start script. + * @param tg + * @param script + */ public final void finalize(final ThreadGroup tg, final Script script) { new Thread(tg, script).start(); } diff --git a/parabotv2/src/org/parabot/environment/scripts/ScriptManifest.java b/parabotv2/src/org/parabot/environment/scripts/ScriptManifest.java index a9df901..562ccc5 100644 --- a/parabotv2/src/org/parabot/environment/scripts/ScriptManifest.java +++ b/parabotv2/src/org/parabot/environment/scripts/ScriptManifest.java @@ -4,7 +4,7 @@ import java.lang.annotation.Retention; import java.lang.annotation.RetentionPolicy; /** - * A script manifest + * A script manifest, holds all script data * @author Everel * */ diff --git a/parabotv2/src/org/parabot/environment/scripts/framework/AbstractFramework.java b/parabotv2/src/org/parabot/environment/scripts/framework/AbstractFramework.java index 020105f..16d8bd0 100644 --- a/parabotv2/src/org/parabot/environment/scripts/framework/AbstractFramework.java +++ b/parabotv2/src/org/parabot/environment/scripts/framework/AbstractFramework.java @@ -1,5 +1,12 @@ package org.parabot.environment.scripts.framework; +/** + * + * Abstract framework for a script + * + * @author Everel + * + */ public abstract class AbstractFramework { public abstract boolean execute(); diff --git a/parabotv2/src/org/parabot/environment/scripts/framework/LoopTask.java b/parabotv2/src/org/parabot/environment/scripts/framework/LoopTask.java index c911c85..243d1cb 100644 --- a/parabotv2/src/org/parabot/environment/scripts/framework/LoopTask.java +++ b/parabotv2/src/org/parabot/environment/scripts/framework/LoopTask.java @@ -1,7 +1,18 @@ package org.parabot.environment.scripts.framework; +/** + * + * A LoopTask interface is used to keep calling the loop method which should return the sleep time + * + * @author Everel + * + */ public interface LoopTask { + /** + * + * @return sleepTime in ms + */ public int loop(); } diff --git a/parabotv2/src/org/parabot/environment/scripts/framework/PythonScript.java b/parabotv2/src/org/parabot/environment/scripts/framework/PythonScript.java index bd773fe..0f7f1a5 100644 --- a/parabotv2/src/org/parabot/environment/scripts/framework/PythonScript.java +++ b/parabotv2/src/org/parabot/environment/scripts/framework/PythonScript.java @@ -2,6 +2,12 @@ package org.parabot.environment.scripts.framework; import org.parabot.environment.scripts.Script; +/** + * Jython script, only supports a loop + * + * @author Everel + * + */ public abstract class PythonScript extends Script { public abstract int loop(); diff --git a/parabotv2/src/org/parabot/environment/scripts/framework/SleepCondition.java b/parabotv2/src/org/parabot/environment/scripts/framework/SleepCondition.java index 5bbd87b..e2b541a 100644 --- a/parabotv2/src/org/parabot/environment/scripts/framework/SleepCondition.java +++ b/parabotv2/src/org/parabot/environment/scripts/framework/SleepCondition.java @@ -1,7 +1,17 @@ package org.parabot.environment.scripts.framework; +/** + * Keeps sleeping till a condition is valid + * + * @author Everel + * + */ public interface SleepCondition { + /** + * Determine if condition is valid + * @return true if valid, otherwise false. + */ public boolean isValid(); } diff --git a/parabotv2/src/org/parabot/environment/scripts/framework/Strategy.java b/parabotv2/src/org/parabot/environment/scripts/framework/Strategy.java index f9d547c..23413e1 100644 --- a/parabotv2/src/org/parabot/environment/scripts/framework/Strategy.java +++ b/parabotv2/src/org/parabot/environment/scripts/framework/Strategy.java @@ -1,9 +1,22 @@ package org.parabot.environment.scripts.framework; +/** + * Strategy framework for scripts + * + * @author Everel + * + */ public interface Strategy { + /** + * Whether to activate this strategy + * @return true if this strategy should be executed, otherwise false. + */ public boolean activate(); + /** + * Executes this strategy + */ public void execute(); } diff --git a/parabotv2/src/org/parabot/environment/scripts/loader/JavaScriptLoader.java b/parabotv2/src/org/parabot/environment/scripts/loader/JavaScriptLoader.java index 2ebf659..212f580 100644 --- a/parabotv2/src/org/parabot/environment/scripts/loader/JavaScriptLoader.java +++ b/parabotv2/src/org/parabot/environment/scripts/loader/JavaScriptLoader.java @@ -10,7 +10,7 @@ import org.parabot.environment.scripts.Script; /** * - * An environment to load a server + * An environment to load a script * * @author Everel * diff --git a/parabotv2/src/org/parabot/environment/servers/PublicServerExecuter.java b/parabotv2/src/org/parabot/environment/servers/PublicServerExecuter.java index 6ae2d39..217949f 100644 --- a/parabotv2/src/org/parabot/environment/servers/PublicServerExecuter.java +++ b/parabotv2/src/org/parabot/environment/servers/PublicServerExecuter.java @@ -18,6 +18,8 @@ import org.parabot.environment.api.utils.WebUtil; import org.parabot.environment.servers.loader.ServerLoader; /** + * + * Fetches a server provider from the parabot sdn * * @author Everel * diff --git a/parabotv2/src/org/parabot/environment/servers/ServerExecuter.java b/parabotv2/src/org/parabot/environment/servers/ServerExecuter.java index cd14893..3bcbcf4 100644 --- a/parabotv2/src/org/parabot/environment/servers/ServerExecuter.java +++ b/parabotv2/src/org/parabot/environment/servers/ServerExecuter.java @@ -4,6 +4,8 @@ import org.parabot.core.Context; import org.parabot.core.ui.components.BotToolbar; /** + * + * Executes a server provider * * @author Everel * diff --git a/parabotv2/src/org/parabot/environment/servers/Type.java b/parabotv2/src/org/parabot/environment/servers/Type.java index 54f2ab7..8d4b217 100644 --- a/parabotv2/src/org/parabot/environment/servers/Type.java +++ b/parabotv2/src/org/parabot/environment/servers/Type.java @@ -2,7 +2,7 @@ package org.parabot.environment.servers; /** * - * Bot type + * Server provider type * * @author Everel *