diff --git a/api/src/main/java/net/md_5/bungee/api/ProxyConfig.java b/api/src/main/java/net/md_5/bungee/api/ProxyConfig.java index 5419445b..40ffa779 100644 --- a/api/src/main/java/net/md_5/bungee/api/ProxyConfig.java +++ b/api/src/main/java/net/md_5/bungee/api/ProxyConfig.java @@ -16,52 +16,72 @@ public interface ProxyConfig /** * Time before users are disconnected due to no network activity. + * + * @return timeout */ int getTimeout(); /** * UUID used for metrics. + * + * @return uuid */ String getUuid(); /** * Set of all listeners. + * + * @return listeners */ Collection getListeners(); /** * Set of all servers. + * + * @return servers */ Map getServers(); /** - * Does the server authenticate with mojang + * Does the server authenticate with Mojang. + * + * @return online mode */ boolean isOnlineMode(); /** - * Whether proxy commands are logged to the proxy log + * Whether proxy commands are logged to the proxy log. + * + * @return log commands */ boolean isLogCommands(); /** * Returns the player max. + * + * @return player limit */ int getPlayerLimit(); /** * A collection of disabled commands. + * + * @return disabled commands */ Collection getDisabledCommands(); /** * The connection throttle delay. + * + * @return throttle */ @Deprecated int getThrottle(); /** * Whether the proxy will parse IPs with spigot or not + * + * @return ip forward */ @Deprecated boolean isIpForward(); @@ -69,6 +89,7 @@ public interface ProxyConfig /** * The encoded favicon. * + * @return favicon * @deprecated Use #getFaviconObject instead. */ @Deprecated @@ -76,6 +97,8 @@ public interface ProxyConfig /** * The favicon used for the server ping list. + * + * @return favicon */ Favicon getFaviconObject(); } diff --git a/api/src/main/java/net/md_5/bungee/api/ProxyServer.java b/api/src/main/java/net/md_5/bungee/api/ProxyServer.java index 15bea8fe..490a0944 100644 --- a/api/src/main/java/net/md_5/bungee/api/ProxyServer.java +++ b/api/src/main/java/net/md_5/bungee/api/ProxyServer.java @@ -52,6 +52,8 @@ public abstract class ProxyServer /** * Gets a localized string from the .properties file. * + * @param name translation name + * @param args translation arguments * @return the localized string */ public abstract String getTranslation(String name, Object... args); diff --git a/api/src/main/java/net/md_5/bungee/api/plugin/PluginManager.java b/api/src/main/java/net/md_5/bungee/api/plugin/PluginManager.java index bf894e4a..81eb3f8a 100644 --- a/api/src/main/java/net/md_5/bungee/api/plugin/PluginManager.java +++ b/api/src/main/java/net/md_5/bungee/api/plugin/PluginManager.java @@ -148,6 +148,9 @@ public class PluginManager * @param sender the sender executing the command * @param commandLine the complete command line including command name and * arguments + * @param tabResults list to place tab results into. If this list is non + * null then the command will not be executed and tab results will be + * returned instead. * @return whether the command was handled */ public boolean dispatchCommand(CommandSender sender, String commandLine, List tabResults) @@ -440,6 +443,8 @@ public class PluginManager /** * Unregister all of a Plugin's listener. + * + * @param plugin target plugin */ public void unregisterListeners(Plugin plugin) { diff --git a/api/src/main/java/net/md_5/bungee/api/scheduler/TaskScheduler.java b/api/src/main/java/net/md_5/bungee/api/scheduler/TaskScheduler.java index 5d2b088c..32732703 100644 --- a/api/src/main/java/net/md_5/bungee/api/scheduler/TaskScheduler.java +++ b/api/src/main/java/net/md_5/bungee/api/scheduler/TaskScheduler.java @@ -86,6 +86,7 @@ public interface TaskScheduler /** * An executor service which underlies this scheduler. * + * @param plugin owning plugin * @return the underlying executor service or compatible wrapper */ ExecutorService getExecutorService(Plugin plugin); diff --git a/event/src/main/java/net/md_5/bungee/event/EventHandler.java b/event/src/main/java/net/md_5/bungee/event/EventHandler.java index c8f1d786..8199228a 100644 --- a/event/src/main/java/net/md_5/bungee/event/EventHandler.java +++ b/event/src/main/java/net/md_5/bungee/event/EventHandler.java @@ -21,6 +21,8 @@ public @interface EventHandler *
  • HIGH
  • *
  • HIGHEST
  • * + * + * @return handler priority */ byte priority() default EventPriority.NORMAL; } diff --git a/protocol/src/main/java/net/md_5/bungee/protocol/packet/Team.java b/protocol/src/main/java/net/md_5/bungee/protocol/packet/Team.java index 85d386c0..a5555f6a 100644 --- a/protocol/src/main/java/net/md_5/bungee/protocol/packet/Team.java +++ b/protocol/src/main/java/net/md_5/bungee/protocol/packet/Team.java @@ -32,6 +32,8 @@ public class Team extends DefinedPacket /** * Packet to destroy a team. + * + * @param name team name */ public Team(String name) { diff --git a/proxy/src/main/java/net/md_5/bungee/BungeeCord.java b/proxy/src/main/java/net/md_5/bungee/BungeeCord.java index 1d36ff94..ad24d012 100644 --- a/proxy/src/main/java/net/md_5/bungee/BungeeCord.java +++ b/proxy/src/main/java/net/md_5/bungee/BungeeCord.java @@ -242,7 +242,7 @@ public class BungeeCord extends ProxyServer * Start this proxy instance by loading the configuration, plugins and * starting the connect thread. * - * @throws Exception + * @throws Exception any critical errors encountered */ @SuppressFBWarnings("RV_RETURN_VALUE_IGNORED_BAD_PRACTICE") public void start() throws Exception