Fix some javadoc warnings
This commit is contained in:
parent
5f29e939b0
commit
2f547f73f7
@ -16,52 +16,72 @@ public interface ProxyConfig
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Time before users are disconnected due to no network activity.
|
* Time before users are disconnected due to no network activity.
|
||||||
|
*
|
||||||
|
* @return timeout
|
||||||
*/
|
*/
|
||||||
int getTimeout();
|
int getTimeout();
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* UUID used for metrics.
|
* UUID used for metrics.
|
||||||
|
*
|
||||||
|
* @return uuid
|
||||||
*/
|
*/
|
||||||
String getUuid();
|
String getUuid();
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Set of all listeners.
|
* Set of all listeners.
|
||||||
|
*
|
||||||
|
* @return listeners
|
||||||
*/
|
*/
|
||||||
Collection<ListenerInfo> getListeners();
|
Collection<ListenerInfo> getListeners();
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Set of all servers.
|
* Set of all servers.
|
||||||
|
*
|
||||||
|
* @return servers
|
||||||
*/
|
*/
|
||||||
Map<String, ServerInfo> getServers();
|
Map<String, ServerInfo> getServers();
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Does the server authenticate with mojang
|
* Does the server authenticate with Mojang.
|
||||||
|
*
|
||||||
|
* @return online mode
|
||||||
*/
|
*/
|
||||||
boolean isOnlineMode();
|
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();
|
boolean isLogCommands();
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Returns the player max.
|
* Returns the player max.
|
||||||
|
*
|
||||||
|
* @return player limit
|
||||||
*/
|
*/
|
||||||
int getPlayerLimit();
|
int getPlayerLimit();
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* A collection of disabled commands.
|
* A collection of disabled commands.
|
||||||
|
*
|
||||||
|
* @return disabled commands
|
||||||
*/
|
*/
|
||||||
Collection<String> getDisabledCommands();
|
Collection<String> getDisabledCommands();
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* The connection throttle delay.
|
* The connection throttle delay.
|
||||||
|
*
|
||||||
|
* @return throttle
|
||||||
*/
|
*/
|
||||||
@Deprecated
|
@Deprecated
|
||||||
int getThrottle();
|
int getThrottle();
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Whether the proxy will parse IPs with spigot or not
|
* Whether the proxy will parse IPs with spigot or not
|
||||||
|
*
|
||||||
|
* @return ip forward
|
||||||
*/
|
*/
|
||||||
@Deprecated
|
@Deprecated
|
||||||
boolean isIpForward();
|
boolean isIpForward();
|
||||||
@ -69,6 +89,7 @@ public interface ProxyConfig
|
|||||||
/**
|
/**
|
||||||
* The encoded favicon.
|
* The encoded favicon.
|
||||||
*
|
*
|
||||||
|
* @return favicon
|
||||||
* @deprecated Use #getFaviconObject instead.
|
* @deprecated Use #getFaviconObject instead.
|
||||||
*/
|
*/
|
||||||
@Deprecated
|
@Deprecated
|
||||||
@ -76,6 +97,8 @@ public interface ProxyConfig
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* The favicon used for the server ping list.
|
* The favicon used for the server ping list.
|
||||||
|
*
|
||||||
|
* @return favicon
|
||||||
*/
|
*/
|
||||||
Favicon getFaviconObject();
|
Favicon getFaviconObject();
|
||||||
}
|
}
|
||||||
|
@ -52,6 +52,8 @@ public abstract class ProxyServer
|
|||||||
/**
|
/**
|
||||||
* Gets a localized string from the .properties file.
|
* Gets a localized string from the .properties file.
|
||||||
*
|
*
|
||||||
|
* @param name translation name
|
||||||
|
* @param args translation arguments
|
||||||
* @return the localized string
|
* @return the localized string
|
||||||
*/
|
*/
|
||||||
public abstract String getTranslation(String name, Object... args);
|
public abstract String getTranslation(String name, Object... args);
|
||||||
|
@ -148,6 +148,9 @@ public class PluginManager
|
|||||||
* @param sender the sender executing the command
|
* @param sender the sender executing the command
|
||||||
* @param commandLine the complete command line including command name and
|
* @param commandLine the complete command line including command name and
|
||||||
* arguments
|
* 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
|
* @return whether the command was handled
|
||||||
*/
|
*/
|
||||||
public boolean dispatchCommand(CommandSender sender, String commandLine, List<String> tabResults)
|
public boolean dispatchCommand(CommandSender sender, String commandLine, List<String> tabResults)
|
||||||
@ -440,6 +443,8 @@ public class PluginManager
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Unregister all of a Plugin's listener.
|
* Unregister all of a Plugin's listener.
|
||||||
|
*
|
||||||
|
* @param plugin target plugin
|
||||||
*/
|
*/
|
||||||
public void unregisterListeners(Plugin plugin)
|
public void unregisterListeners(Plugin plugin)
|
||||||
{
|
{
|
||||||
|
@ -86,6 +86,7 @@ public interface TaskScheduler
|
|||||||
/**
|
/**
|
||||||
* An executor service which underlies this scheduler.
|
* An executor service which underlies this scheduler.
|
||||||
*
|
*
|
||||||
|
* @param plugin owning plugin
|
||||||
* @return the underlying executor service or compatible wrapper
|
* @return the underlying executor service or compatible wrapper
|
||||||
*/
|
*/
|
||||||
ExecutorService getExecutorService(Plugin plugin);
|
ExecutorService getExecutorService(Plugin plugin);
|
||||||
|
@ -21,6 +21,8 @@ public @interface EventHandler
|
|||||||
* <li>HIGH</li>
|
* <li>HIGH</li>
|
||||||
* <li>HIGHEST</li>
|
* <li>HIGHEST</li>
|
||||||
* </ol>
|
* </ol>
|
||||||
|
*
|
||||||
|
* @return handler priority
|
||||||
*/
|
*/
|
||||||
byte priority() default EventPriority.NORMAL;
|
byte priority() default EventPriority.NORMAL;
|
||||||
}
|
}
|
||||||
|
@ -32,6 +32,8 @@ public class Team extends DefinedPacket
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Packet to destroy a team.
|
* Packet to destroy a team.
|
||||||
|
*
|
||||||
|
* @param name team name
|
||||||
*/
|
*/
|
||||||
public Team(String name)
|
public Team(String name)
|
||||||
{
|
{
|
||||||
|
@ -242,7 +242,7 @@ public class BungeeCord extends ProxyServer
|
|||||||
* Start this proxy instance by loading the configuration, plugins and
|
* Start this proxy instance by loading the configuration, plugins and
|
||||||
* starting the connect thread.
|
* starting the connect thread.
|
||||||
*
|
*
|
||||||
* @throws Exception
|
* @throws Exception any critical errors encountered
|
||||||
*/
|
*/
|
||||||
@SuppressFBWarnings("RV_RETURN_VALUE_IGNORED_BAD_PRACTICE")
|
@SuppressFBWarnings("RV_RETURN_VALUE_IGNORED_BAD_PRACTICE")
|
||||||
public void start() throws Exception
|
public void start() throws Exception
|
||||||
|
Loading…
Reference in New Issue
Block a user