diff --git a/api/src/main/java/net/md_5/bungee/api/ServerPing.java b/api/src/main/java/net/md_5/bungee/api/ServerPing.java index a12498a1..d1dda171 100644 --- a/api/src/main/java/net/md_5/bungee/api/ServerPing.java +++ b/api/src/main/java/net/md_5/bungee/api/ServerPing.java @@ -10,9 +10,24 @@ import lombok.Data; public class ServerPing { + /** + * Numeric protocol version supported by the server. + */ private final byte protocolVersion; + /** + * Human readable game version. + */ private final String gameVersion; + /** + * Server MOTD. + */ private final String motd; + /** + * Current amount of players on the server. + */ private final String currentPlayers; + /** + * Max amount of players the server will allow. + */ private final String maxPlayers; } diff --git a/api/src/main/java/net/md_5/bungee/api/config/ConfigurationAdapter.java b/api/src/main/java/net/md_5/bungee/api/config/ConfigurationAdapter.java index 0f3c3d14..7e5981d5 100644 --- a/api/src/main/java/net/md_5/bungee/api/config/ConfigurationAdapter.java +++ b/api/src/main/java/net/md_5/bungee/api/config/ConfigurationAdapter.java @@ -1,8 +1,6 @@ package net.md_5.bungee.api.config; import java.util.Collection; -import java.util.List; -import net.md_5.bungee.api.CommandSender; /** * This class allows plugins to set their own configuration adapter to load @@ -50,12 +48,12 @@ public interface ConfigurationAdapter public Collection getListeners(); /** - * Get all groups this user is in. + * Get all groups this player is in. * - * @param user the user to check - * @return all the user's groups. + * @param player the player to check + * @return all the player's groups. */ - public Collection getGroups(String user); + public Collection getGroups(String player); /** * Get all permission corresponding to the specified group. The result of diff --git a/api/src/main/java/net/md_5/bungee/api/config/ListenerInfo.java b/api/src/main/java/net/md_5/bungee/api/config/ListenerInfo.java index 47e29389..84765ad7 100644 --- a/api/src/main/java/net/md_5/bungee/api/config/ListenerInfo.java +++ b/api/src/main/java/net/md_5/bungee/api/config/ListenerInfo.java @@ -16,7 +16,7 @@ public class ListenerInfo */ private final InetSocketAddress host; /** - * Displayed motd. + * Displayed MOTD. */ private final String motd; /** diff --git a/api/src/main/java/net/md_5/bungee/api/event/TargetedEvent.java b/api/src/main/java/net/md_5/bungee/api/event/TargetedEvent.java index b4d3208c..800990b8 100644 --- a/api/src/main/java/net/md_5/bungee/api/event/TargetedEvent.java +++ b/api/src/main/java/net/md_5/bungee/api/event/TargetedEvent.java @@ -15,6 +15,12 @@ import net.md_5.bungee.api.connection.Connection; public abstract class TargetedEvent { + /** + * Creator of the action. + */ private Connection sender; + /** + * Receiver of the action. + */ private Connection receiver; } diff --git a/api/src/main/java/net/md_5/bungee/api/plugin/PluginDescription.java b/api/src/main/java/net/md_5/bungee/api/plugin/PluginDescription.java index 6f124efa..0739cec8 100644 --- a/api/src/main/java/net/md_5/bungee/api/plugin/PluginDescription.java +++ b/api/src/main/java/net/md_5/bungee/api/plugin/PluginDescription.java @@ -2,12 +2,27 @@ package net.md_5.bungee.api.plugin; import lombok.Data; +/** + * POJO representing the plugin.yml file. + */ @Data public class PluginDescription { + /** + * Friendly name of the plugin. + */ private final String name; + /** + * Plugin main class. Needs to extend {@link Plugin}. + */ private final String main; + /** + * Plugin version. + */ private final String version; + /** + * Plugin author. + */ private final String author; }