Tad more Javadoc

This commit is contained in:
md_5 2013-01-12 17:31:21 +11:00
parent fe6b40a6a8
commit 8c942e299f
5 changed files with 41 additions and 7 deletions

View File

@ -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;
}

View File

@ -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<ListenerInfo> 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<String> getGroups(String user);
public Collection<String> getGroups(String player);
/**
* Get all permission corresponding to the specified group. The result of

View File

@ -16,7 +16,7 @@ public class ListenerInfo
*/
private final InetSocketAddress host;
/**
* Displayed motd.
* Displayed MOTD.
*/
private final String motd;
/**

View File

@ -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;
}

View File

@ -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;
}