From b84161fde204d4788614f5e346ecc499be75e568 Mon Sep 17 00:00:00 2001 From: "Kristian S. Stangeland" Date: Tue, 13 Nov 2012 17:50:36 +0100 Subject: [PATCH] Fix documentation. --- .../java/com/comphenix/protocol/events/PacketAdapter.java | 1 - .../java/com/comphenix/protocol/injector/ListenerInvoker.java | 1 - .../protocol/injector/player/PlayerInjectionHandler.java | 1 - .../java/com/comphenix/protocol/reflect/PrettyPrinter.java | 1 - .../com/comphenix/protocol/reflect/StructureModifier.java | 4 ++-- .../java/com/comphenix/protocol/utility/ChatExtensions.java | 1 - .../com/comphenix/protocol/wrappers/WrappedDataWatcher.java | 2 +- 7 files changed, 3 insertions(+), 8 deletions(-) diff --git a/ProtocolLib/src/main/java/com/comphenix/protocol/events/PacketAdapter.java b/ProtocolLib/src/main/java/com/comphenix/protocol/events/PacketAdapter.java index aa13233f..5043ca25 100644 --- a/ProtocolLib/src/main/java/com/comphenix/protocol/events/PacketAdapter.java +++ b/ProtocolLib/src/main/java/com/comphenix/protocol/events/PacketAdapter.java @@ -99,7 +99,6 @@ public abstract class PacketAdapter implements PacketListener { * Initialize a packet listener for a single connection side. * @param plugin - the plugin that spawned this listener. * @param connectionSide - the packet type the listener is looking for. - * @param listenerPriority - the event priority. * @param gamePhase - which game phase this listener is active under. * @param packets - the packet IDs the listener is looking for. */ diff --git a/ProtocolLib/src/main/java/com/comphenix/protocol/injector/ListenerInvoker.java b/ProtocolLib/src/main/java/com/comphenix/protocol/injector/ListenerInvoker.java index ae48ea6d..52c52e7d 100644 --- a/ProtocolLib/src/main/java/com/comphenix/protocol/injector/ListenerInvoker.java +++ b/ProtocolLib/src/main/java/com/comphenix/protocol/injector/ListenerInvoker.java @@ -50,7 +50,6 @@ public interface ListenerInvoker { /** * Associate a given class with the given packet ID. Internal method. * @param clazz - class to associate. - * @param packetID - the packet ID. */ public abstract void unregisterPacketClass(Class clazz); diff --git a/ProtocolLib/src/main/java/com/comphenix/protocol/injector/player/PlayerInjectionHandler.java b/ProtocolLib/src/main/java/com/comphenix/protocol/injector/player/PlayerInjectionHandler.java index b627810f..373df511 100644 --- a/ProtocolLib/src/main/java/com/comphenix/protocol/injector/player/PlayerInjectionHandler.java +++ b/ProtocolLib/src/main/java/com/comphenix/protocol/injector/player/PlayerInjectionHandler.java @@ -442,7 +442,6 @@ public class PlayerInjectionHandler { * the method will try a workaround to remove the injected hook in the NetServerHandler. * * @param address - address of the player to unregister. - * @param serverHandler - whether or not the net server handler has already been created. * @return TRUE if a player has been uninjected, FALSE otherwise. */ public boolean uninjectPlayer(InetSocketAddress address) { diff --git a/ProtocolLib/src/main/java/com/comphenix/protocol/reflect/PrettyPrinter.java b/ProtocolLib/src/main/java/com/comphenix/protocol/reflect/PrettyPrinter.java index 51f22558..33ceb604 100644 --- a/ProtocolLib/src/main/java/com/comphenix/protocol/reflect/PrettyPrinter.java +++ b/ProtocolLib/src/main/java/com/comphenix/protocol/reflect/PrettyPrinter.java @@ -35,7 +35,6 @@ public class PrettyPrinter { * Print the content of an object. * @param object - the object to serialize. * @param stop - superclass that will stop the process. - * @param depth - how far in the hierachy until we stop. * @return String representation of the class. * @throws IllegalAccessException */ diff --git a/ProtocolLib/src/main/java/com/comphenix/protocol/reflect/StructureModifier.java b/ProtocolLib/src/main/java/com/comphenix/protocol/reflect/StructureModifier.java index 556af330..9323065d 100644 --- a/ProtocolLib/src/main/java/com/comphenix/protocol/reflect/StructureModifier.java +++ b/ProtocolLib/src/main/java/com/comphenix/protocol/reflect/StructureModifier.java @@ -87,7 +87,7 @@ public class StructureModifier { * @param targetType - the structure to modify. * @param superclassExclude - a superclass to exclude. * @param requireDefault - whether or not we will be using writeDefaults(). - * @param useStructureModifier - whether or not to automatically compile this structure modifier. + * @param useStructureCompiler - whether or not to automatically compile this structure modifier. */ public StructureModifier(Class targetType, Class superclassExclude, boolean requireDefault, boolean useStructureCompiler) { List fields = getFields(targetType, superclassExclude); @@ -137,7 +137,7 @@ public class StructureModifier { * @param defaultFields - list of fields that will be automatically initialized. * @param converter - converts between the common field type and the actual type the consumer expects. * @param subTypeCache - a structure modifier cache. - * @param useStructureModifier - whether or not to automatically compile this structure modifier. + * @param useStructureCompiler - whether or not to automatically compile this structure modifier. */ protected void initialize(Class targetType, Class fieldType, List data, Map defaultFields, diff --git a/ProtocolLib/src/main/java/com/comphenix/protocol/utility/ChatExtensions.java b/ProtocolLib/src/main/java/com/comphenix/protocol/utility/ChatExtensions.java index ff7621a5..cdacdbdd 100644 --- a/ProtocolLib/src/main/java/com/comphenix/protocol/utility/ChatExtensions.java +++ b/ProtocolLib/src/main/java/com/comphenix/protocol/utility/ChatExtensions.java @@ -30,7 +30,6 @@ public class ChatExtensions { * Send a message without invoking the packet listeners. * @param receiver - the receiver. * @param message - the message to send. - * @return TRUE if the message was sent successfully, FALSE otherwise. * @throws InvocationTargetException If we were unable to send the message. */ public void sendMessageSilently(CommandSender receiver, String message) throws InvocationTargetException { diff --git a/ProtocolLib/src/main/java/com/comphenix/protocol/wrappers/WrappedDataWatcher.java b/ProtocolLib/src/main/java/com/comphenix/protocol/wrappers/WrappedDataWatcher.java index f8326c6c..7290b036 100644 --- a/ProtocolLib/src/main/java/com/comphenix/protocol/wrappers/WrappedDataWatcher.java +++ b/ProtocolLib/src/main/java/com/comphenix/protocol/wrappers/WrappedDataWatcher.java @@ -73,7 +73,7 @@ public class WrappedDataWatcher { /** * Create a wrapper for a given data watcher. - * @param dataWatcher - the data watcher to wrap. + * @param handle - the data watcher to wrap. * @throws FieldAccessException If we're unable to wrap a DataWatcher. */ public WrappedDataWatcher(DataWatcher handle) {