Pulling all pending Bukkit-JavaDoc changes
A special thanks goes to @aerouk for almost all of the changes found here. By: Wesley Wolfe <weswolf@aol.com>
This commit is contained in:
@@ -48,7 +48,8 @@ public class ServerCommandEvent extends ServerEvent {
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets the command that the user is attempting to execute from the console
|
||||
* Gets the command that the user is attempting to execute from the
|
||||
* console
|
||||
*
|
||||
* @return Command the user is attempting to execute
|
||||
*/
|
||||
|
||||
@@ -80,9 +80,9 @@ public class ServerListPingEvent extends ServerEvent {
|
||||
* Sets the server-icon sent to the client.
|
||||
*
|
||||
* @param icon the icon to send to the client
|
||||
* @throws IllegalArgumentException if the {@link CachedServerIcon} is
|
||||
* not created by the caller of this event; null may be accepted for
|
||||
* some implementations
|
||||
* @throws IllegalArgumentException if the {@link CachedServerIcon} is not
|
||||
* created by the caller of this event; null may be accepted for some
|
||||
* implementations
|
||||
* @throws UnsupportedOperationException if the caller of this event does
|
||||
* not support setting the server icon
|
||||
*/
|
||||
|
||||
@@ -3,7 +3,8 @@ package org.bukkit.event.server;
|
||||
import org.bukkit.plugin.RegisteredServiceProvider;
|
||||
|
||||
/**
|
||||
* An event relating to a registered service. This is called in a {@link org.bukkit.plugin.ServicesManager}
|
||||
* An event relating to a registered service. This is called in a {@link
|
||||
* org.bukkit.plugin.ServicesManager}
|
||||
*/
|
||||
public abstract class ServiceEvent extends ServerEvent {
|
||||
private final RegisteredServiceProvider<?> provider;
|
||||
|
||||
@@ -4,9 +4,10 @@ import org.bukkit.event.HandlerList;
|
||||
import org.bukkit.plugin.RegisteredServiceProvider;
|
||||
|
||||
/**
|
||||
* This event is called when a service is registered.<br>
|
||||
* <b>Warning:</b> The order in which register and unregister
|
||||
* events are called should not be relied upon.
|
||||
* This event is called when a service is registered.
|
||||
* <p>
|
||||
* Warning: The order in which register and unregister events are called
|
||||
* should not be relied upon.
|
||||
*/
|
||||
public class ServiceRegisterEvent extends ServiceEvent {
|
||||
private static final HandlerList handlers = new HandlerList();
|
||||
|
||||
@@ -4,9 +4,10 @@ import org.bukkit.event.HandlerList;
|
||||
import org.bukkit.plugin.RegisteredServiceProvider;
|
||||
|
||||
/**
|
||||
* This event is called when a service is unregistered.<br>
|
||||
* <b>Warning:</b> The order in which register and unregister
|
||||
* events are called should not be relied upon.
|
||||
* This event is called when a service is unregistered.
|
||||
* <p>
|
||||
* Warning: The order in which register and unregister events are called
|
||||
* should not be relied upon.
|
||||
*/
|
||||
public class ServiceUnregisterEvent extends ServiceEvent {
|
||||
private static final HandlerList handlers = new HandlerList();
|
||||
|
||||
Reference in New Issue
Block a user