Fix javadoc errors/warnings

By: Celtic Minstrel <celtic.minstrel.ca@some.place>
This commit is contained in:
Bukkit/Spigot
2012-02-26 10:35:17 -05:00
parent 5ebb8d2b3e
commit 795a61bbeb
28 changed files with 79 additions and 65 deletions

View File

@@ -35,7 +35,7 @@ public class InvalidPluginException extends Exception {
/**
* Constructs a new InvalidPluginException with the specified detail message
*
* @param the detail message. The detail message is saved for later retrieval by the getMessage() method.
* @param message TThe detail message is saved for later retrieval by the getMessage() method.
*/
public InvalidPluginException(final String message) {
super(message);

View File

@@ -5,17 +5,17 @@ import java.util.logging.LogRecord;
import java.util.logging.Logger;
/**
* The PluginLogger class is a modified {@link java.util.logging.Logger} that prepends all logging calls with the name of the
* plugin doing the logging.
* The PluginLogger class is a modified {@link Logger} that prepends all logging calls with the name of the
* plugin doing the logging. The API for PluginLogger is exactly the same as {@link Logger}.
*
* The API for PluginLogger is exactly the same as {@link java.util.logging.Logger}.
* @see Logger
*/
public class PluginLogger extends Logger {
private String pluginName;
/**
* Creates a new PluginLogger that extracts the name from a plugin.
* @param context
* @param context A reference to the plugin
*/
public PluginLogger(Plugin context) {
super(context.getClass().getCanonicalName(), null);

View File

@@ -92,7 +92,6 @@ public interface PluginManager {
* Calls an event with the given details
*
* @param event Event details
* @return Called event
*/
public void callEvent(Event event);

View File

@@ -51,6 +51,7 @@ public class RegisteredListener {
* Calls the event executor
*
* @param event The event
* @throws EventException If an event handler throws an exception.
*/
public void callEvent(final Event event) throws EventException {
if (event instanceof Cancellable){

View File

@@ -64,7 +64,7 @@ public interface Messenger {
* @param plugin Plugin that wishes to register to this channel.
* @param channel Channel to register.
* @param listener Listener to receive messages on.
* @returns The resulting registration that was made as a result of this method.
* @return The resulting registration that was made as a result of this method.
* @throws IllegalArgumentException Thrown if plugin, channel or listener is null, or the listener is already registered for this channel.
*/
public PluginMessageListenerRegistration registerIncomingPluginChannel(Plugin plugin, String channel, PluginMessageListener listener);