From 2a18a07d91519a2af96dc04fe7a5d3787ffe7b73 Mon Sep 17 00:00:00 2001 From: Thinkofdeath Date: Sun, 30 Nov 2014 21:09:01 +0000 Subject: Clean up the javadoc to pass java 8's doclint --- src/main/java/org/bukkit/BanEntry.java | 1 + src/main/java/org/bukkit/Bukkit.java | 730 ++++++++++++++++----- src/main/java/org/bukkit/ChatColor.java | 6 +- src/main/java/org/bukkit/Color.java | 4 +- src/main/java/org/bukkit/EntityEffect.java | 2 +- src/main/java/org/bukkit/FireworkEffect.java | 3 + src/main/java/org/bukkit/Location.java | 7 +- src/main/java/org/bukkit/Server.java | 5 +- src/main/java/org/bukkit/UnsafeValues.java | 2 +- src/main/java/org/bukkit/World.java | 14 +- src/main/java/org/bukkit/block/Block.java | 11 +- src/main/java/org/bukkit/block/BlockState.java | 1 + src/main/java/org/bukkit/command/Command.java | 7 + .../org/bukkit/command/defaults/HelpCommand.java | 2 +- .../org/bukkit/configuration/Configuration.java | 2 +- .../configuration/file/FileConfiguration.java | 2 +- .../serialization/ConfigurationSerializable.java | 6 +- src/main/java/org/bukkit/entity/CreatureType.java | 3 + src/main/java/org/bukkit/entity/Damageable.java | 17 +- src/main/java/org/bukkit/entity/Entity.java | 3 +- src/main/java/org/bukkit/entity/EntityType.java | 6 + src/main/java/org/bukkit/entity/LivingEntity.java | 4 + src/main/java/org/bukkit/entity/Minecart.java | 4 + src/main/java/org/bukkit/entity/Player.java | 4 +- src/main/java/org/bukkit/entity/Projectile.java | 4 + src/main/java/org/bukkit/event/EventHandler.java | 4 + .../org/bukkit/event/block/BlockCanBuildEvent.java | 3 + .../org/bukkit/event/block/BlockIgniteEvent.java | 4 - .../org/bukkit/event/block/BlockPhysicsEvent.java | 2 + .../org/bukkit/event/block/SignChangeEvent.java | 8 +- .../org/bukkit/event/entity/EntityDamageEvent.java | 7 + .../bukkit/event/entity/EntityPortalExitEvent.java | 6 +- .../event/entity/EntityRegainHealthEvent.java | 6 + .../org/bukkit/event/player/PlayerFishEvent.java | 8 +- .../org/bukkit/event/player/PlayerLoginEvent.java | 6 + .../bukkit/event/server/ServerListPingEvent.java | 4 + .../bukkit/event/vehicle/VehicleDamageEvent.java | 4 + .../org/bukkit/event/world/StructureGrowEvent.java | 4 +- .../java/org/bukkit/generator/ChunkGenerator.java | 34 +- src/main/java/org/bukkit/help/HelpMap.java | 2 +- .../java/org/bukkit/inventory/EntityEquipment.java | 40 +- .../java/org/bukkit/inventory/InventoryView.java | 1 + src/main/java/org/bukkit/inventory/ItemStack.java | 8 + .../org/bukkit/inventory/meta/FireworkMeta.java | 4 +- .../java/org/bukkit/inventory/meta/ItemMeta.java | 2 +- src/main/java/org/bukkit/map/MapCursor.java | 3 + src/main/java/org/bukkit/map/MapView.java | 2 +- src/main/java/org/bukkit/material/Banner.java | 9 +- src/main/java/org/bukkit/material/Bed.java | 7 +- src/main/java/org/bukkit/material/Button.java | 8 +- src/main/java/org/bukkit/material/Cake.java | 8 +- src/main/java/org/bukkit/material/Cauldron.java | 3 + src/main/java/org/bukkit/material/Chest.java | 8 +- src/main/java/org/bukkit/material/Coal.java | 8 +- src/main/java/org/bukkit/material/CocoaPlant.java | 5 +- src/main/java/org/bukkit/material/Command.java | 8 +- src/main/java/org/bukkit/material/Crops.java | 8 +- .../java/org/bukkit/material/DetectorRail.java | 8 +- src/main/java/org/bukkit/material/Diode.java | 8 +- .../org/bukkit/material/DirectionalContainer.java | 8 +- src/main/java/org/bukkit/material/Dispenser.java | 8 +- src/main/java/org/bukkit/material/Door.java | 8 +- src/main/java/org/bukkit/material/Dye.java | 8 +- src/main/java/org/bukkit/material/EnderChest.java | 8 +- .../java/org/bukkit/material/ExtendedRails.java | 8 +- src/main/java/org/bukkit/material/FlowerPot.java | 8 +- src/main/java/org/bukkit/material/Furnace.java | 8 +- .../org/bukkit/material/FurnaceAndDispenser.java | 8 +- src/main/java/org/bukkit/material/Ladder.java | 8 +- src/main/java/org/bukkit/material/Leaves.java | 8 +- src/main/java/org/bukkit/material/Lever.java | 8 +- src/main/java/org/bukkit/material/LongGrass.java | 8 +- .../java/org/bukkit/material/MaterialData.java | 8 +- src/main/java/org/bukkit/material/MonsterEggs.java | 8 +- src/main/java/org/bukkit/material/Mushroom.java | 6 +- src/main/java/org/bukkit/material/NetherWarts.java | 8 +- .../org/bukkit/material/PistonBaseMaterial.java | 20 +- .../bukkit/material/PistonExtensionMaterial.java | 8 +- src/main/java/org/bukkit/material/PoweredRail.java | 8 +- .../java/org/bukkit/material/PressurePlate.java | 8 +- src/main/java/org/bukkit/material/Pumpkin.java | 8 +- src/main/java/org/bukkit/material/Rails.java | 8 +- .../java/org/bukkit/material/RedstoneTorch.java | 8 +- .../java/org/bukkit/material/RedstoneWire.java | 8 +- src/main/java/org/bukkit/material/Sandstone.java | 8 +- src/main/java/org/bukkit/material/Sign.java | 8 +- .../material/SimpleAttachableMaterialData.java | 8 +- src/main/java/org/bukkit/material/Skull.java | 8 +- src/main/java/org/bukkit/material/SmoothBrick.java | 8 +- src/main/java/org/bukkit/material/SpawnEgg.java | 5 +- src/main/java/org/bukkit/material/Stairs.java | 8 +- src/main/java/org/bukkit/material/Step.java | 8 +- .../java/org/bukkit/material/TexturedMaterial.java | 8 +- src/main/java/org/bukkit/material/Torch.java | 8 +- src/main/java/org/bukkit/material/TrapDoor.java | 8 +- src/main/java/org/bukkit/material/Tree.java | 8 +- src/main/java/org/bukkit/material/Tripwire.java | 5 +- .../java/org/bukkit/material/TripwireHook.java | 5 +- src/main/java/org/bukkit/material/Vine.java | 5 +- src/main/java/org/bukkit/material/WoodenStep.java | 8 +- src/main/java/org/bukkit/material/Wool.java | 8 +- .../org/bukkit/metadata/LazyMetadataValue.java | 2 + .../java/org/bukkit/permissions/Permission.java | 7 +- .../org/bukkit/plugin/PluginDescriptionFile.java | 12 +- .../org/bukkit/plugin/TimedRegisteredListener.java | 2 +- .../java/org/bukkit/plugin/java/JavaPlugin.java | 14 + .../org/bukkit/plugin/java/JavaPluginLoader.java | 2 + src/main/java/org/bukkit/potion/Potion.java | 17 +- src/main/java/org/bukkit/potion/PotionType.java | 3 + .../org/bukkit/projectiles/ProjectileSource.java | 2 + .../java/org/bukkit/scheduler/BukkitScheduler.java | 52 +- src/main/java/org/bukkit/util/StringUtil.java | 1 + .../bukkit/util/io/BukkitObjectInputStream.java | 7 +- .../bukkit/util/io/BukkitObjectOutputStream.java | 7 +- .../javadoc/org/bukkit/block/package-info.java | 1 - .../org/bukkit/command/defaults/package-info.java | 1 - .../javadoc/org/bukkit/command/package-info.java | 1 - .../bukkit/configuration/file/package-info.java | 1 - .../org/bukkit/configuration/package-info.java | 1 - .../configuration/serialization/package-info.java | 1 - .../org/bukkit/conversations/package-info.java | 1 - .../org/bukkit/enchantments/package-info.java | 1 - .../org/bukkit/entity/minecart/package-info.java | 1 - .../javadoc/org/bukkit/entity/package-info.java | 1 - .../org/bukkit/event/block/package-info.java | 1 - .../org/bukkit/event/enchantment/package-info.java | 1 - .../org/bukkit/event/entity/package-info.java | 1 - .../org/bukkit/event/hanging/package-info.java | 1 - .../org/bukkit/event/inventory/package-info.java | 1 - .../javadoc/org/bukkit/event/package-info.java | 1 - .../org/bukkit/event/painting/package-info.java | 1 - .../org/bukkit/event/player/package-info.java | 1 - .../org/bukkit/event/server/package-info.java | 1 - .../org/bukkit/event/vehicle/package-info.java | 1 - .../org/bukkit/event/weather/package-info.java | 1 - .../org/bukkit/event/world/package-info.java | 1 - .../javadoc/org/bukkit/generator/package-info.java | 1 - src/main/javadoc/org/bukkit/help/package-info.java | 1 - .../org/bukkit/inventory/meta/package-info.java | 1 - .../javadoc/org/bukkit/inventory/package-info.java | 1 - src/main/javadoc/org/bukkit/map/package-info.java | 1 - .../javadoc/org/bukkit/material/package-info.java | 1 - .../javadoc/org/bukkit/metadata/package-info.java | 1 - src/main/javadoc/org/bukkit/package-info.java | 1 - .../org/bukkit/permissions/package-info.java | 1 - .../org/bukkit/plugin/java/package-info.java | 1 - .../org/bukkit/plugin/messaging/package-info.java | 1 - .../javadoc/org/bukkit/plugin/package-info.java | 1 - .../javadoc/org/bukkit/potion/package-info.java | 1 - .../org/bukkit/projectiles/package-info.java | 1 - .../javadoc/org/bukkit/scheduler/package-info.java | 1 - .../org/bukkit/scoreboard/package-info.java | 1 - .../javadoc/org/bukkit/util/io/package-info.java | 1 - .../org/bukkit/util/noise/package-info.java | 1 - src/main/javadoc/org/bukkit/util/package-info.java | 1 - .../org/bukkit/util/permissions/package-info.java | 1 - 156 files changed, 1129 insertions(+), 475 deletions(-) (limited to 'src/main') diff --git a/src/main/java/org/bukkit/BanEntry.java b/src/main/java/org/bukkit/BanEntry.java index 986120e5..b2437c6d 100644 --- a/src/main/java/org/bukkit/BanEntry.java +++ b/src/main/java/org/bukkit/BanEntry.java @@ -8,6 +8,7 @@ import java.util.Date; *

* Ban entries include the following properties: * + * * * * diff --git a/src/main/java/org/bukkit/Bukkit.java b/src/main/java/org/bukkit/Bukkit.java index 1eaf92d7..2c43d9e3 100644 --- a/src/main/java/org/bukkit/Bukkit.java +++ b/src/main/java/org/bukkit/Bukkit.java @@ -2,7 +2,9 @@ package org.bukkit; import java.awt.image.BufferedImage; import java.io.File; +import java.io.Serializable; import java.util.Collection; +import java.util.Collections; import java.util.Iterator; import java.util.List; import java.util.Map; @@ -15,15 +17,17 @@ import org.bukkit.command.CommandException; import org.bukkit.command.CommandSender; import org.bukkit.command.ConsoleCommandSender; import org.bukkit.command.PluginCommand; +import org.bukkit.entity.Entity; import org.bukkit.entity.Player; import org.bukkit.event.inventory.InventoryType; +import org.bukkit.event.server.ServerListPingEvent; import org.bukkit.help.HelpMap; -import org.bukkit.inventory.ItemStack; import org.bukkit.inventory.Inventory; import org.bukkit.inventory.InventoryHolder; -import org.bukkit.inventory.ItemFactory; +import org.bukkit.inventory.ItemStack; import org.bukkit.inventory.Recipe; import org.bukkit.map.MapView; +import org.bukkit.permissions.Permissible; import org.bukkit.plugin.PluginManager; import org.bukkit.plugin.ServicesManager; import org.bukkit.plugin.messaging.Messenger; @@ -32,6 +36,10 @@ import org.bukkit.scoreboard.ScoreboardManager; import org.bukkit.util.CachedServerIcon; import com.avaje.ebean.config.ServerConfig; +import com.google.common.collect.ImmutableList; + +import org.bukkit.inventory.ItemFactory; +import org.bukkit.inventory.meta.ItemMeta; /** * Represents the Bukkit core, for version and Server singleton handling @@ -70,33 +78,41 @@ public final class Bukkit { } /** - * @see Server#getName() + * Gets the name of this server implementation. + * + * @return name of this server implementation */ public static String getName() { return server.getName(); } /** - * @see Server#getVersion() + * Gets the version string of this server implementation. + * + * @return version of this server implementation */ public static String getVersion() { return server.getVersion(); } /** - * @see Server#getBukkitVersion() + * Gets the Bukkit version that this server is running. + * + * @return version of Bukkit */ public static String getBukkitVersion() { return server.getBukkitVersion(); } /** + * Gets an array copy of all currently logged in players. + *

* This method exists for legacy reasons to provide backwards * compatibility. It will not exist at runtime and should not be used * under any circumstances. * - * @Deprecated - * @see Server#_INVALID_getOnlinePlayers() + * @deprecated superseded by {@link #getOnlinePlayers()} + * @return an array of Players that are currently online */ @Deprecated public static Player[] _INVALID_getOnlinePlayers() { @@ -104,98 +120,262 @@ public final class Bukkit { } /** - * @see Server#getOnlinePlayers() + * Gets a view of all currently logged in players. This {@linkplain + * Collections#unmodifiableCollection(Collection) view} is a reused + * object, making some operations like {@link Collection#size()} + * zero-allocation. + *

+ * The collection is a view backed by the internal representation, such + * that, changes to the internal state of the server will be reflected + * immediately. However, the reuse of the returned collection (identity) + * is not strictly guaranteed for future or all implementations. Casting + * the collection, or relying on interface implementations (like {@link + * Serializable} or {@link List}), is deprecated. + *

+ * Iteration behavior is undefined outside of self-contained main-thread + * uses. Normal and immediate iterator use without consequences that + * affect the collection are fully supported. The effects following + * (non-exhaustive) {@link Entity#teleport(Location) teleportation}, + * {@link Player#setHealth(double) death}, and {@link Player#kickPlayer( + * String) kicking} are undefined. Any use of this collection from + * asynchronous threads is unsafe. + *

+ * For safe consequential iteration or mimicking the old array behavior, + * using {@link Collection#toArray(Object[])} is recommended. For making + * snapshots, {@link ImmutableList#copyOf(Collection)} is recommended. + * + * @return a view of currently online players. */ public static Collection getOnlinePlayers() { return server.getOnlinePlayers(); } /** - * @see Server#getMaxPlayers() + * Get the maximum amount of players which can login to this server. + * + * @return the amount of players this server allows */ public static int getMaxPlayers() { return server.getMaxPlayers(); } /** - * @see Server#getPort() + * Get the game port that the server runs on. + * + * @return the port number of this server */ public static int getPort() { return server.getPort(); } /** - * @see Server#getViewDistance() + * Get the view distance from this server. + * + * @return the view distance from this server. */ public static int getViewDistance() { return server.getViewDistance(); } /** - * @see Server#getIp() + * Get the IP that this server is bound to, or empty string if not + * specified. + * + * @return the IP string that this server is bound to, otherwise empty + * string */ public static String getIp() { return server.getIp(); } /** - * @see Server#getServerName() + * Get the name of this server. + * + * @return the name of this server */ public static String getServerName() { return server.getServerName(); } /** - * @see Server#getServerId() + * Get an ID of this server. The ID is a simple generally alphanumeric ID + * that can be used for uniquely identifying this server. + * + * @return the ID of this server */ public static String getServerId() { return server.getServerId(); } - + /** - * @see Server#getWorldType() + * Get world type (level-type setting) for default world. + * + * @return the value of level-type (e.g. DEFAULT, FLAT, DEFAULT_1_1) */ public static String getWorldType() { return server.getWorldType(); } /** - * @see Server#getGenerateStructures() + * Get generate-structures setting. + * + * @return true if structure generation is enabled, false otherwise */ public static boolean getGenerateStructures() { return server.getGenerateStructures(); } /** - * @see Server#getAllowNether() + * Gets whether this server allows the End or not. + * + * @return whether this server allows the End or not + */ + public static boolean getAllowEnd() { + return server.getAllowEnd(); + } + + /** + * Gets whether this server allows the Nether or not. + * + * @return whether this server allows the Nether or not */ public static boolean getAllowNether() { return server.getAllowNether(); } /** - * @see Server#hasWhitelist() + * Gets whether this server has a whitelist or not. + * + * @return whether this server has a whitelist or not */ public static boolean hasWhitelist() { return server.hasWhitelist(); } /** - * @see Server#broadcastMessage(String message) + * Sets if the server is whitelisted. + * + * @param value true for whitelist on, false for off + */ + public static void setWhitelist(boolean value) { + server.setWhitelist(value); + } + + /** + * Gets a list of whitelisted players. + * + * @return a set containing all whitelisted players + */ + public static Set getWhitelistedPlayers() { + return server.getWhitelistedPlayers(); + } + + /** + * Reloads the whitelist from disk. + */ + public static void reloadWhitelist() { + server.reloadWhitelist(); + } + + /** + * Broadcast a message to all players. + *

+ * This is the same as calling {@link #broadcast(java.lang.String, + * java.lang.String)} to {@link Server#BROADCAST_CHANNEL_USERS} + * + * @param message the message + * @return the number of players */ public static int broadcastMessage(String message) { return server.broadcastMessage(message); } /** - * @see Server#getUpdateFolder() + * Gets the name of the update folder. The update folder is used to safely + * update plugins at the right moment on a plugin load. + *

+ * The update folder name is relative to the plugins folder. + * + * @return the name of the update folder */ public static String getUpdateFolder() { return server.getUpdateFolder(); } /** - * @see Server#getPlayer(String name) + * Gets the update folder. The update folder is used to safely update + * plugins at the right moment on a plugin load. + * + * @return the update folder + */ + public static File getUpdateFolderFile() { + return server.getUpdateFolderFile(); + } + + /** + * Gets the value of the connection throttle setting. + * + * @return the value of the connection throttle setting + */ + public static long getConnectionThrottle() { + return server.getConnectionThrottle(); + } + + /** + * Gets default ticks per animal spawns value. + *

+ * Example Usage: + *

+ *

+ * Note: If set to 0, animal spawning will be disabled. We + * recommend using spawn-animals to control this instead. + *

+ * Minecraft default: 400. + * + * @return the default ticks per animal spawns value + */ + public static int getTicksPerAnimalSpawns() { + return server.getTicksPerAnimalSpawns(); + } + + /** + * Gets the default ticks per monster spawns value. + *

+ * Example Usage: + *

+ *

+ * Note: If set to 0, monsters spawning will be disabled. We + * recommend using spawn-monsters to control this instead. + *

+ * Minecraft default: 1. + * + * @return the default ticks per monsters spawn value + */ + public static int getTicksPerMonsterSpawns() { + return server.getTicksPerMonsterSpawns(); + } + + /** + * Gets a player object by the given username. + *

+ * This method may not return objects for offline players. + * + * @deprecated Use {@link #getPlayer(UUID)} as player names are no longer + * guaranteed to be unique + * @param name the name to look up + * @return a player if one was found, null otherwise */ @Deprecated public static Player getPlayer(String name) { @@ -203,7 +383,29 @@ public final class Bukkit { } /** - * @see Server#matchPlayer(String name) + * Gets the player with the exact given name, case insensitive. + * + * @deprecated Use {@link #getPlayer(UUID)} as player names are no longer + * guaranteed to be unique + * @param name Exact name of the player to retrieve + * @return a player object if one was found, null otherwise + */ + @Deprecated + public static Player getPlayerExact(String name) { + return server.getPlayerExact(name); + } + + /** + * Attempts to match any players with the given name, and returns a list + * of all possibly matches. + *

+ * This list is not sorted in any particular order. If an exact match is + * found, the returned list will only contain a single result. + * + * @deprecated Use {@link #getPlayer(UUID)} as player names are no longer + * guaranteed to be unique + * @param name the (partial) name to match + * @return list of all possible players */ @Deprecated public static List matchPlayer(String name) { @@ -211,77 +413,112 @@ public final class Bukkit { } /** - * @see Server#getPlayer(java.util.UUID) + * Gets the player with the given UUID. + * + * @param id UUID of the player to retrieve + * @return a player object if one was found, null otherwise */ public static Player getPlayer(UUID id) { return server.getPlayer(id); } /** - * @see Server#getPluginManager() + * Gets the plugin manager for interfacing with plugins. + * + * @return a plugin manager for this Server instance */ public static PluginManager getPluginManager() { return server.getPluginManager(); } /** - * @see Server#getScheduler() + * Gets the scheduler for managing scheduled events. + * + * @return a scheduling service for this server */ public static BukkitScheduler getScheduler() { return server.getScheduler(); } /** - * @see Server#getServicesManager() + * Gets a services manager. + * + * @return s services manager */ public static ServicesManager getServicesManager() { return server.getServicesManager(); } /** - * @see Server#getWorlds() + * Gets a list of all worlds on this server. + * + * @return a list of worlds */ public static List getWorlds() { return server.getWorlds(); } /** - * @see Server#createWorld(WorldCreator options) + * Creates or loads a world with the given name using the specified + * options. + *

+ * If the world is already loaded, it will just return the equivalent of + * getWorld(creator.name()). + * + * @param creator the options to use when creating the world + * @return newly created or loaded world */ - public static World createWorld(WorldCreator options) { - return server.createWorld(options); + public static World createWorld(WorldCreator creator) { + return server.createWorld(creator); } /** - * @see Server#unloadWorld(String name, boolean save) + * Unloads a world with the given name. + * + * @param name Name of the world to unload + * @param save whether to save the chunks before unloading + * @return true if successful, false otherwise */ public static boolean unloadWorld(String name, boolean save) { return server.unloadWorld(name, save); } /** - * @see Server#unloadWorld(World world, boolean save) + * Unloads the given world. + * + * @param world the world to unload + * @param save whether to save the chunks before unloading + * @return true if successful, false otherwise */ public static boolean unloadWorld(World world, boolean save) { return server.unloadWorld(world, save); } /** - * @see Server#getWorld(String name) + * Gets the world with the given name. + * + * @param name the name of the world to retrieve + * @return a world with the given name, or null if none exists */ public static World getWorld(String name) { return server.getWorld(name); } /** - * @see Server#getWorld(UUID uid) + * Gets the world from the given Unique ID. + * + * @param uid a unique-id of the world to retrieve + * @return a world with the given Unique ID, or null if none exists */ public static World getWorld(UUID uid) { return server.getWorld(uid); } /** - * @see Server#getMap(short id) + * Gets the map from the given item ID. + * + * @param id the id of the map to get + * @return a map view if it exists, or null otherwise * @deprecated Magic value */ @Deprecated @@ -290,147 +527,222 @@ public final class Bukkit { } /** - * @see Server#createMap(World world) + * Create a new map with an automatically assigned ID. + * + * @param world the world the map will belong to + * @return a newly created map view */ public static MapView createMap(World world) { return server.createMap(world); } /** - * @see Server#reload() + * Reloads the server, refreshing settings and plugin information. */ public static void reload() { server.reload(); } /** - * @see Server#getLogger() + * Returns the primary logger associated with this server instance. + * + * @return Logger associated with this server */ public static Logger getLogger() { return server.getLogger(); } /** - * @see Server#getPluginCommand(String name) + * Gets a {@link PluginCommand} with the given name or alias. + * + * @param name the name of the command to retrieve + * @return a plugin command if found, null otherwise */ public static PluginCommand getPluginCommand(String name) { return server.getPluginCommand(name); } /** - * @see Server#savePlayers() + * Writes loaded players to disk. */ public static void savePlayers() { server.savePlayers(); } - + /** - * @see Server#dispatchCommand(CommandSender sender, String commandLine) + * Dispatches a command on this server, and executes it if found. + * + * @param sender the apparent sender of the command + * @param commandLine the command + arguments. Example: test abc + * 123 + * @return returns false if no target is found + * @throws CommandException thrown when the executor for the given command + * fails with an unhandled exception */ public static boolean dispatchCommand(CommandSender sender, String commandLine) throws CommandException { return server.dispatchCommand(sender, commandLine); } /** - * @see Server#configureDbConfig(ServerConfig config) + * Populates a given {@link ServerConfig} with values attributes to this + * server. + * + * @param config the server config to populate */ public static void configureDbConfig(ServerConfig config) { server.configureDbConfig(config); } /** - * @see Server#addRecipe(Recipe recipe) + * Adds a recipe to the crafting manager. + * + * @param recipe the recipe to add + * @return true if the recipe was added, false if it wasn't for some + * reason */ public static boolean addRecipe(Recipe recipe) { return server.addRecipe(recipe); } /** - * @see Server#getRecipesFor(ItemStack result) + * Get a list of all recipes for a given item. The stack size is ignored + * in comparisons. If the durability is -1, it will match any data value. + * + * @param result the item to match against recipe results + * @return a list of recipes with the given result */ public static List getRecipesFor(ItemStack result) { return server.getRecipesFor(result); } /** - * @see Server#recipeIterator() + * Get an iterator through the list of crafting recipes. + * + * @return an iterator */ public static Iterator recipeIterator() { return server.recipeIterator(); } /** - * @see Server#clearRecipes() + * Clears the list of crafting recipes. */ public static void clearRecipes() { server.clearRecipes(); } /** - * @see Server#resetRecipes() + * Resets the list of crafting recipes to the default. */ public static void resetRecipes() { server.resetRecipes(); } - + /** - * @see Server#getCommandAliases() + * Gets a list of command aliases defined in the server properties. + * + * @return a map of aliases to command names */ public static Map getCommandAliases() { return server.getCommandAliases(); } /** - * @see Server#getSpawnRadius() + * Gets the radius, in blocks, around each worlds spawn point to protect. + * + * @return spawn radius, or 0 if none */ public static int getSpawnRadius() { return server.getSpawnRadius(); } /** - * @see Server#setSpawnRadius(int value) + * Sets the radius, in blocks, around each worlds spawn point to protect. + * + * @param value new spawn radius, or 0 if none */ public static void setSpawnRadius(int value) { server.setSpawnRadius(value); } /** - * @see Server#getOnlineMode() + * Gets whether the Server is in online mode or not. + * + * @return true if the server authenticates clients, false otherwise */ public static boolean getOnlineMode() { return server.getOnlineMode(); } /** - * @see Server#getAllowFlight() + * Gets whether this server allows flying or not. + * + * @return true if the server allows flight, false otherwise */ public static boolean getAllowFlight() { return server.getAllowFlight(); } /** - * @see Server#isHardcore() + * Gets whether the server is in hardcore mode or not. + * + * @return true if the server mode is hardcore, false otherwise */ public static boolean isHardcore() { return server.isHardcore(); } /** - * @see Server#shutdown() + * Gets whether to use vanilla (false) or exact behaviour (true). + * + *

+ * + * @return true if exact location locations are used for spawning, false + * for vanilla collision detection or otherwise + */ + public static boolean useExactLoginLocation() { + return server.useExactLoginLocation(); + } + + /** + * Shutdowns the server, stopping everything. */ public static void shutdown() { server.shutdown(); } /** - * @see Server#broadcast(String message, String permission) + * Broadcasts the specified message to every user with the given + * permission name. + * + * @param message message to broadcast + * @param permission the required permission {@link Permissible + * permissibles} must have to receive the broadcast + * @return number of message recipients */ public static int broadcast(String message, String permission) { return server.broadcast(message, permission); } /** - * @see Server#getOfflinePlayer(String name) + * Gets the player by the given name, regardless if they are offline or + * online. + *

+ * This method may involve a blocking web request to get the UUID for the + * given name. + *

+ * This will return an object even if the player does not exist. To this + * method, all players will exist. + * + * @deprecated Persistent storage of users should be by UUID as names are no longer + * unique past a single session. + * @param name the name the player to retrieve + * @return an offline player + * @see #getOfflinePlayer(java.util.UUID) */ @Deprecated public static OfflinePlayer getOfflinePlayer(String name) { @@ -438,310 +750,372 @@ public final class Bukkit { } /** - * @see Server#getOfflinePlayer(java.util.UUID) + * Gets the player by the given UUID, regardless if they are offline or + * online. + *

+ * This will return an object even if the player does not exist. To this + * method, all players will exist. + * + * @param id the UUID of the player to retrieve + * @return an offline player */ public static OfflinePlayer getOfflinePlayer(UUID id) { return server.getOfflinePlayer(id); } /** - * @see Server#getPlayerExact(String name) - */ - @Deprecated - public static Player getPlayerExact(String name) { - return server.getPlayerExact(name); - } - - /** - * @see Server#getIPBans() + * Gets a set containing all current IPs that are banned. + * + * @return a set containing banned IP addresses */ public static Set getIPBans() { return server.getIPBans(); } /** - * @see Server#banIP(String address) + * Bans the specified address from the server. + * + * @param address the IP address to ban */ public static void banIP(String address) { server.banIP(address); } /** - * @see Server#unbanIP(String address) + * Unbans the specified address from the server. + * + * @param address the IP address to unban */ public static void unbanIP(String address) { server.unbanIP(address); } /** - * @see Server#getBannedPlayers() + * Gets a set containing all banned players. + * + * @return a set containing banned players */ public static Set getBannedPlayers() { return server.getBannedPlayers(); } /** - * @see Server#getBanList(BanList.Type) + * Gets a ban list for the supplied type. + *

+ * Bans by name are no longer supported and this method will return + * null when trying to request them. The replacement is bans by UUID. + * + * @param type the type of list to fetch, cannot be null + * @return a ban list of the specified type */ public static BanList getBanList(BanList.Type type){ return server.getBanList(type); } /** - * @see Server#setWhitelist(boolean value) + * Gets a set containing all player operators. + * + * @return a set containing player operators */ - public static void setWhitelist(boolean value) { - server.setWhitelist(value); + public static Set getOperators() { + return server.getOperators(); } /** - * @see Server#getWhitelistedPlayers() + * Gets the default {@link GameMode} for new players. + * + * @return the default game mode */ - public static Set getWhitelistedPlayers() { - return server.getWhitelistedPlayers(); + public static GameMode getDefaultGameMode() { + return server.getDefaultGameMode(); } /** - * @see Server#reloadWhitelist() + * Sets the default {@link GameMode} for new players. + * + * @param mode the new game mode */ - public static void reloadWhitelist() { - server.reloadWhitelist(); + public static void setDefaultGameMode(GameMode mode) { + server.setDefaultGameMode(mode); } /** - * @see Server#getConsoleSender() + * Gets a {@link ConsoleCommandSender} that may be used as an input source + * for this server. + * + * @return a console command sender */ public static ConsoleCommandSender getConsoleSender() { return server.getConsoleSender(); } /** - * @see Server#getOperators() - */ - public static Set getOperators() { - return server.getOperators(); - } - - /** - * @see Server#getWorldContainer() + * Gets the folder that contains all of the various {@link World}s. + * + * @return folder that contains all worlds */ public static File getWorldContainer() { return server.getWorldContainer(); } /** - * @see Server#getMessenger() - */ - public static Messenger getMessenger() { - return server.getMessenger(); - } - - /** - * @see Server#getAllowEnd() - */ - public static boolean getAllowEnd() { - return server.getAllowEnd(); - } - - /** - * @see Server#getUpdateFolderFile() - */ - public static File getUpdateFolderFile() { - return server.getUpdateFolderFile(); - } - - /** - * @see Server#getConnectionThrottle() - */ - public static long getConnectionThrottle() { - return server.getConnectionThrottle(); - } - - /** - * @see Server#getTicksPerAnimalSpawns() - */ - public static int getTicksPerAnimalSpawns() { - return server.getTicksPerAnimalSpawns(); - } - - /** - * @see Server#getTicksPerMonsterSpawns() - */ - public static int getTicksPerMonsterSpawns() { - return server.getTicksPerMonsterSpawns(); - } - - /** - * @see Server#useExactLoginLocation() - */ - public static boolean useExactLoginLocation() { - return server.useExactLoginLocation(); - } - - /** - * @see Server#getDefaultGameMode() + * Gets every player that has ever played on this server. + * + * @return an array containing all previous players */ - public static GameMode getDefaultGameMode() { - return server.getDefaultGameMode(); + public static OfflinePlayer[] getOfflinePlayers() { + return server.getOfflinePlayers(); } /** - * @see Server#setDefaultGameMode(GameMode mode) + * Gets the {@link Messenger} responsible for this server. + * + * @return messenger responsible for this server */ - public static void setDefaultGameMode(GameMode mode) { - server.setDefaultGameMode(mode); + public static Messenger getMessenger() { + return server.getMessenger(); } /** - * @see Server#getOfflinePlayers() + * Gets the {@link HelpMap} providing help topics for this server. + * + * @return a help map for this server */ - public static OfflinePlayer[] getOfflinePlayers() { - return server.getOfflinePlayers(); + public static HelpMap getHelpMap() { + return server.getHelpMap(); } /** - * @see Server#createInventory(InventoryHolder owner, InventoryType type) + * Creates an empty inventory of the specified type. If the type is {@link + * InventoryType#CHEST}, the new inventory has a size of 27; otherwise the + * new inventory has the normal size for its type. + * + * @param owner the holder of the inventory, or null to indicate no holder + * @param type the type of inventory to create + * @return a new inventory */ public static Inventory createInventory(InventoryHolder owner, InventoryType type) { return server.createInventory(owner, type); } /** - * @see Server#createInventory(InventoryHolder owner, InventoryType type, String title) + * Creates an empty inventory with the specified type and title. If the type + * is {@link InventoryType#CHEST}, the new inventory has a size of 27; + * otherwise the new inventory has the normal size for its type.
+ * It should be noted that some inventory types do not support titles and + * may not render with said titles on the Minecraft client. + * + * @param owner The holder of the inventory; can be null if there's no holder. + * @param type The type of inventory to create. + * @param title The title of the inventory, to be displayed when it is viewed. + * @return The new inventory. */ public static Inventory createInventory(InventoryHolder owner, InventoryType type, String title) { return server.createInventory(owner, type, title); } /** - * @see Server#createInventory(InventoryHolder owner, int size) + * Creates an empty inventory of type {@link InventoryType#CHEST} with the + * specified size. + * + * @param owner the holder of the inventory, or null to indicate no holder + * @param size a multiple of 9 as the size of inventory to create + * @return a new inventory + * @throws IllegalArgumentException if the size is not a multiple of 9 */ public static Inventory createInventory(InventoryHolder owner, int size) throws IllegalArgumentException { return server.createInventory(owner, size); } /** - * @see Server#createInventory(InventoryHolder owner, int size, String - * title) + * Creates an empty inventory of type {@link InventoryType#CHEST} with the + * specified size and title. + * + * @param owner the holder of the inventory, or null to indicate no holder + * @param size a multiple of 9 as the size of inventory to create + * @param title the title of the inventory, displayed when inventory is + * viewed + * @return a new inventory + * @throws IllegalArgumentException if the size is not a multiple of 9 */ public static Inventory createInventory(InventoryHolder owner, int size, String title) throws IllegalArgumentException { return server.createInventory(owner, size, title); } /** - * @see Server#getHelpMap() - */ - public static HelpMap getHelpMap() { - return server.getHelpMap(); - } - - /** - * @see Server#getMonsterSpawnLimit() + * Gets user-specified limit for number of monsters that can spawn in a + * chunk. + * + * @return the monster spawn limit */ public static int getMonsterSpawnLimit() { return server.getMonsterSpawnLimit(); } /** - * @see Server#getAnimalSpawnLimit() + * Gets user-specified limit for number of animals that can spawn in a + * chunk. + * + * @return the animal spawn limit */ public static int getAnimalSpawnLimit() { return server.getAnimalSpawnLimit(); } /** - * @see Server#getWaterAnimalSpawnLimit() + * Gets user-specified limit for number of water animals that can spawn in + * a chunk. + * + * @return the water animal spawn limit */ public static int getWaterAnimalSpawnLimit() { return server.getWaterAnimalSpawnLimit(); } - + /** - * @see Server#getAmbientSpawnLimit() + * Gets user-specified limit for number of ambient mobs that can spawn in + * a chunk. + * + * @return the ambient spawn limit */ public static int getAmbientSpawnLimit() { return server.getAmbientSpawnLimit(); } /** - * @see Server#isPrimaryThread() + * Checks the current thread against the expected primary thread for the + * server. + *

+ * Note: this method should not be used to indicate the current + * synchronized state of the runtime. A current thread matching the main + * thread indicates that it is synchronized, but a mismatch does not + * preclude the same assumption. + * + * @return true if the current thread matches the expected primary thread, + * false otherwise */ public static boolean isPrimaryThread() { return server.isPrimaryThread(); } /** - * @see Server#getMotd() + * Gets the message that is displayed on the server list. + * + * @return the servers MOTD */ public static String getMotd() { return server.getMotd(); } /** - * @see Server#getShutdownMessage() + * Gets the default message that is displayed when the server is stopped. + * + * @return the shutdown message */ public static String getShutdownMessage() { return server.getShutdownMessage(); } /** - * @see Server#getWarningState() + * Gets the current warning state for the server. + * + * @return the configured warning state */ public static WarningState getWarningState() { return server.getWarningState(); } /** - * @see Server#getItemFactory() + * Gets the instance of the item factory (for {@link ItemMeta}). + * + * @return the item factory + * @see ItemFactory */ public static ItemFactory getItemFactory() { return server.getItemFactory(); } /** - * @see Server#getScoreboardManager() + * Gets the instance of the scoreboard manager. + *

+ * This will only exist after the first world has loaded. + * + * @return the scoreboard manager or null if no worlds are loaded. */ public static ScoreboardManager getScoreboardManager() { return server.getScoreboardManager(); } /** - * @see Server#getServerIcon() + * Gets an instance of the server's default server-icon. + * + * @return the default server-icon; null values may be used by the + * implementation to indicate no defined icon, but this behavior is + * not guaranteed */ public static CachedServerIcon getServerIcon() { return server.getServerIcon(); } /** - * @see Server#loadServerIcon(File) + * Loads an image from a file, and returns a cached image for the specific + * server-icon. + *

+ * Size and type are implementation defined. An incompatible file is + * guaranteed to throw an implementation-defined {@link Exception}. + * + * @param file the file to load the from + * @throws IllegalArgumentException if image is null + * @throws Exception if the image does not meet current server server-icon + * specifications + * @return a cached server-icon that can be used for a {@link + * ServerListPingEvent#setServerIcon(CachedServerIcon)} */ public static CachedServerIcon loadServerIcon(File file) throws IllegalArgumentException, Exception { return server.loadServerIcon(file); } /** - * @see Server#loadServerIcon(BufferedImage) + * Creates a cached server-icon for the specific image. + *

+ * Size and type are implementation defined. An incompatible file is + * guaranteed to throw an implementation-defined {@link Exception}. + * + * @param image the image to use + * @throws IllegalArgumentException if image is null + * @throws Exception if the image does not meet current server + * server-icon specifications + * @return a cached server-icon that can be used for a {@link + * ServerListPingEvent#setServerIcon(CachedServerIcon)} */ public static CachedServerIcon loadServerIcon(BufferedImage image) throws IllegalArgumentException, Exception { return server.loadServerIcon(image); } /** - * @see Server#setIdleTimeout(int) + * Set the idle kick timeout. Any players idle for the specified amount of + * time will be automatically kicked. + *

+ * A value of 0 will disable the idle kick timeout. + * + * @param threshold the idle timeout in minutes */ public static void setIdleTimeout(int threshold) { server.setIdleTimeout(threshold); } /** - * @see Server#getIdleTimeout() + * Gets the idle kick timeout. + * + * @return the idle timeout in minutes */ public static int getIdleTimeout() { return server.getIdleTimeout(); } /** - * @see Server#getUnsafe() + * @see UnsafeValues + * @return the unsafe values instance */ @Deprecated public static UnsafeValues getUnsafe() { diff --git a/src/main/java/org/bukkit/ChatColor.java b/src/main/java/org/bukkit/ChatColor.java index 0bbc9fac..b8872b41 100644 --- a/src/main/java/org/bukkit/ChatColor.java +++ b/src/main/java/org/bukkit/ChatColor.java @@ -141,6 +141,8 @@ public enum ChatColor { /** * Checks if this code is a format code as opposed to a color code. + * + * @return whether this ChatColor is a format code */ public boolean isFormat() { return isFormat; @@ -148,6 +150,8 @@ public enum ChatColor { /** * Checks if this code is a color code as opposed to a format code. + * + * @return whether this ChatColor is a color code */ public boolean isColor() { return !isFormat && this != RESET; @@ -198,7 +202,7 @@ public enum ChatColor { * character. The alternate color code character will only be replaced if * it is immediately followed by 0-9, A-F, a-f, K-O, k-o, R or r. * - * @param altColorChar The alternate color code character to replace. Ex: & + * @param altColorChar The alternate color code character to replace. Ex: {@literal &} * @param textToTranslate Text containing the alternate color code character. * @return Text containing the ChatColor.COLOR_CODE color code character. */ diff --git a/src/main/java/org/bukkit/Color.java b/src/main/java/org/bukkit/Color.java index 76ff651f..83927dde 100644 --- a/src/main/java/org/bukkit/Color.java +++ b/src/main/java/org/bukkit/Color.java @@ -113,7 +113,7 @@ public final class Color implements ConfigurationSerializable { * @param green integer from 0-255 * @param blue integer from 0-255 * @return a new Color object for the red, green, blue - * @throws IllegalArgumentException if any value is strictly >255 or <0 + * @throws IllegalArgumentException if any value is strictly {@literal >255 or <0} */ public static Color fromRGB(int red, int green, int blue) throws IllegalArgumentException { return new Color(red, green, blue); @@ -126,7 +126,7 @@ public final class Color implements ConfigurationSerializable { * @param green integer from 0-255 * @param red integer from 0-255 * @return a new Color object for the red, green, blue - * @throws IllegalArgumentException if any value is strictly >255 or <0 + * @throws IllegalArgumentException if any value is strictly {@literal >255 or <0} */ public static Color fromBGR(int blue, int green, int red) throws IllegalArgumentException { return new Color(red, green, blue); diff --git a/src/main/java/org/bukkit/EntityEffect.java b/src/main/java/org/bukkit/EntityEffect.java index ec7d1e39..c816edfd 100644 --- a/src/main/java/org/bukkit/EntityEffect.java +++ b/src/main/java/org/bukkit/EntityEffect.java @@ -17,7 +17,7 @@ public enum EntityEffect { /** * When a mob dies. *

- * This will cause client-glitches! + * This will cause client-glitches! */ DEATH(3), diff --git a/src/main/java/org/bukkit/FireworkEffect.java b/src/main/java/org/bukkit/FireworkEffect.java index 6f2d0968..4b0687fe 100644 --- a/src/main/java/org/bukkit/FireworkEffect.java +++ b/src/main/java/org/bukkit/FireworkEffect.java @@ -351,6 +351,8 @@ public final class FireworkEffect implements ConfigurationSerializable { /** * @see ConfigurationSerializable + * @param map the map to deserialize + * @return the resulting serializable */ public static ConfigurationSerializable deserialize(Map map) { Type type = Type.valueOf((String) map.get(TYPE)); @@ -367,6 +369,7 @@ public final class FireworkEffect implements ConfigurationSerializable { .build(); } + @Override public Map serialize() { return ImmutableMap.of( FLICKER, flicker, diff --git a/src/main/java/org/bukkit/Location.java b/src/main/java/org/bukkit/Location.java index 5c18507b..37fecc10 100644 --- a/src/main/java/org/bukkit/Location.java +++ b/src/main/java/org/bukkit/Location.java @@ -209,7 +209,7 @@ public class Location implements Cloneable { *

  • A pitch of 90 represents downward facing, or negative y * direction. *
  • A pitch of -90 represents upward facing, or positive y direction. - *
      + *
    * Increasing pitch values the equivalent of looking down. * * @param pitch new incline's pitch @@ -225,7 +225,7 @@ public class Location implements Cloneable { *
  • A pitch of 90 represents downward facing, or negative y * direction. *
  • A pitch of -90 represents upward facing, or positive y direction. - *
      + *
    * Increasing pitch values the equivalent of looking down. * * @return the incline's pitch @@ -260,6 +260,9 @@ public class Location implements Cloneable { /** * Sets the {@link #getYaw() yaw} and {@link #getPitch() pitch} to point * in the direction of the vector. + * + * @param vector the direction vector + * @return the same location */ public Location setDirection(Vector vector) { /* diff --git a/src/main/java/org/bukkit/Server.java b/src/main/java/org/bukkit/Server.java index e14e9f1d..ab6d047d 100644 --- a/src/main/java/org/bukkit/Server.java +++ b/src/main/java/org/bukkit/Server.java @@ -91,7 +91,7 @@ public interface Server extends PluginMessageRecipient { * compatibility. It will not exist at runtime and should not be used * under any circumstances. * - * @Deprecated superseded by {@link #getOnlinePlayers()} + * @deprecated superseded by {@link #getOnlinePlayers()} * @return an array of Players that are currently online */ @Deprecated @@ -735,7 +735,7 @@ public interface Server extends PluginMessageRecipient { /** * Creates an empty inventory with the specified type and title. If the type * is {@link InventoryType#CHEST}, the new inventory has a size of 27; - * otherwise the new inventory has the normal size for its type.
    + * otherwise the new inventory has the normal size for its type.
    * It should be noted that some inventory types do not support titles and * may not render with said titles on the Minecraft client. * @@ -913,6 +913,7 @@ public interface Server extends PluginMessageRecipient { /** * @see UnsafeValues + * @return the unsafe values instance */ @Deprecated UnsafeValues getUnsafe(); diff --git a/src/main/java/org/bukkit/UnsafeValues.java b/src/main/java/org/bukkit/UnsafeValues.java index fc8a179c..568c83e3 100644 --- a/src/main/java/org/bukkit/UnsafeValues.java +++ b/src/main/java/org/bukkit/UnsafeValues.java @@ -14,7 +14,7 @@ import org.bukkit.inventory.ItemStack; *

    * This interface is unsupported and only for internal use. * - * @deprecated Unsupported & internal use only + * @deprecated Unsupported {@literal &} internal use only */ @Deprecated public interface UnsafeValues { diff --git a/src/main/java/org/bukkit/World.java b/src/main/java/org/bukkit/World.java index 9bf2c41b..d306201c 100644 --- a/src/main/java/org/bukkit/World.java +++ b/src/main/java/org/bukkit/World.java @@ -402,6 +402,7 @@ public interface World extends PluginMessageRecipient, Metadatable { * Get a collection of all entities in this World matching the given * class/interface * + * @param an entity subclass * @param classes The classes representing the types of entity to match * @return A List of all Entities currently residing in this world that * match the given class/interface @@ -412,7 +413,8 @@ public interface World extends PluginMessageRecipient, Metadatable { /** * Get a collection of all entities in this World matching the given * class/interface - * + * + * @param an entity subclass * @param cls The class representing the type of entity to match * @return A List of all Entities currently residing in this world that * match the given class/interface @@ -746,6 +748,7 @@ public interface World extends PluginMessageRecipient, Metadatable { * Plays an effect to all players within a default radius around a given * location. * + * @param data dependant on the type of effect * @param location the {@link Location} around which players must be to * hear the sound * @param effect the {@link Effect} @@ -756,6 +759,7 @@ public interface World extends PluginMessageRecipient, Metadatable { /** * Plays an effect to all players within a given radius around a location. * + * @param data dependant on the type of effect * @param location the {@link Location} around which players must be to * hear the effect * @param effect the {@link Effect} @@ -1050,6 +1054,8 @@ public interface World extends PluginMessageRecipient, Metadatable { *

    * Note: If set to a negative number the world will use the * server-wide spawn limit instead. + * + * @param limit the new mob limit */ void setMonsterSpawnLimit(int limit); @@ -1067,6 +1073,8 @@ public interface World extends PluginMessageRecipient, Metadatable { *

    * Note: If set to a negative number the world will use the * server-wide spawn limit instead. + * + * @param limit the new mob limit */ void setAnimalSpawnLimit(int limit); @@ -1084,6 +1092,8 @@ public interface World extends PluginMessageRecipient, Metadatable { *

    * Note: If set to a negative number the world will use the * server-wide spawn limit instead. + * + * @param limit the new mob limit */ void setWaterAnimalSpawnLimit(int limit); @@ -1101,6 +1111,8 @@ public interface World extends PluginMessageRecipient, Metadatable { *

    * Note: If set to a negative number the world will use the * server-wide spawn limit instead. + * + * @param limit the new mob limit */ void setAmbientSpawnLimit(int limit); diff --git a/src/main/java/org/bukkit/block/Block.java b/src/main/java/org/bukkit/block/Block.java index 4a53109a..38e84415 100644 --- a/src/main/java/org/bukkit/block/Block.java +++ b/src/main/java/org/bukkit/block/Block.java @@ -148,6 +148,7 @@ public interface Block extends Metadatable { * If the provided Location is null this method does nothing and returns * null. * + * @param loc the location to copy into * @return The Location object provided or null */ Location getLocation(Location loc); @@ -219,16 +220,16 @@ public interface Block extends Metadatable { boolean setTypeIdAndData(int type, byte data, boolean applyPhysics); /** - * Gets the face relation of this block compared to the given block + * Gets the face relation of this block compared to the given block. *

    - * For example: - * 

    +     * For example: 
+     * 
    {@code
      * Block current = world.getBlockAt(100, 100, 100);
      * Block target = world.getBlockAt(100, 101, 100);
      *
      * current.getFace(target) == BlockFace.Up;
-     * 
    
-     * 
    
+     * }
    + *
    * If the given block is not connected to this block, null may be returned * * @param block Block to compare against this block diff --git a/src/main/java/org/bukkit/block/BlockState.java b/src/main/java/org/bukkit/block/BlockState.java index ca571739..96bf1d0d 100644 --- a/src/main/java/org/bukkit/block/BlockState.java +++ b/src/main/java/org/bukkit/block/BlockState.java @@ -96,6 +96,7 @@ public interface BlockState extends Metadatable { * If the provided Location is null this method does nothing and returns * null. * + * @param loc the location to copy into * @return The Location object provided or null */ Location getLocation(Location loc); diff --git a/src/main/java/org/bukkit/command/Command.java b/src/main/java/org/bukkit/command/Command.java index 87c33d9c..e5fb0f8f 100644 --- a/src/main/java/org/bukkit/command/Command.java +++ b/src/main/java/org/bukkit/command/Command.java @@ -57,7 +57,14 @@ public abstract class Command { public abstract boolean execute(CommandSender sender, String commandLabel, String[] args); /** + * Executed on tab completion for this command, returning a list of + * options the player can tab through. + * * @deprecated This method is not supported and returns null + * @param sender Source object which is executing this command + * @param args All arguments passed to the command, split via ' ' + * @return a list of tab-completions for the specified arguments. This + * will never be null. List may be immutable. */ @Deprecated public List tabComplete(CommandSender sender, String[] args) { diff --git a/src/main/java/org/bukkit/command/defaults/HelpCommand.java b/src/main/java/org/bukkit/command/defaults/HelpCommand.java index ff73b26f..aa359e4a 100644 --- a/src/main/java/org/bukkit/command/defaults/HelpCommand.java +++ b/src/main/java/org/bukkit/command/defaults/HelpCommand.java @@ -165,7 +165,7 @@ public class HelpCommand extends VanillaCommand { /** * Computes the Dameraur-Levenshtein Distance between two strings. Adapted - * from the algorithm at Wikipedia: Damerau–Levenshtein distance + * from the algorithm at Wikipedia: Damerau–Levenshtein distance * * @param s1 The first string being compared. * @param s2 The second string being compared. diff --git a/src/main/java/org/bukkit/configuration/Configuration.java b/src/main/java/org/bukkit/configuration/Configuration.java index 9289c218..52e3ac42 100644 --- a/src/main/java/org/bukkit/configuration/Configuration.java +++ b/src/main/java/org/bukkit/configuration/Configuration.java @@ -29,7 +29,7 @@ public interface Configuration extends ConfigurationSection { * collection, then a new {@link MemoryConfiguration} will be created to * hold the new default values. * - * @param defaults A map of Path->Values to add to defaults. + * @param defaults A map of Path{@literal ->}Values to add to defaults. * @throws IllegalArgumentException Thrown if defaults is null. */ public void addDefaults(Map defaults); diff --git a/src/main/java/org/bukkit/configuration/file/FileConfiguration.java b/src/main/java/org/bukkit/configuration/file/FileConfiguration.java index 9d6d1c61..9cbe0cad 100644 --- a/src/main/java/org/bukkit/configuration/file/FileConfiguration.java +++ b/src/main/java/org/bukkit/configuration/file/FileConfiguration.java @@ -271,7 +271,7 @@ public abstract class FileConfiguration extends MemoryConfiguration { * Compiles the header for this {@link FileConfiguration} and returns the * result. *

    - * This will use the header from {@link #options()} -> {@link + * This will use the header from {@link #options()} -> {@link * FileConfigurationOptions#header()}, respecting the rules of {@link * FileConfigurationOptions#copyHeader()} if set. * diff --git a/src/main/java/org/bukkit/configuration/serialization/ConfigurationSerializable.java b/src/main/java/org/bukkit/configuration/serialization/ConfigurationSerializable.java index ba3c8c47..74b73f9d 100644 --- a/src/main/java/org/bukkit/configuration/serialization/ConfigurationSerializable.java +++ b/src/main/java/org/bukkit/configuration/serialization/ConfigurationSerializable.java @@ -9,11 +9,11 @@ import java.util.Map; * methods as defined by this interface: *

      *
    • A static method "deserialize" that accepts a single {@link Map}< - * {@link String}, {@link Object}> and returns the class.
      • + * {@link String}, {@link Object}> and returns the class. *
    • A static method "valueOf" that accepts a single {@link Map}<{@link - * String}, {@link Object}> and returns the class.
      • + * String}, {@link Object}> and returns the class. *
    • A constructor that accepts a single {@link Map}<{@link String}, - * {@link Object}>.
      • + * {@link Object}>. *
    * In addition to implementing this interface, you must register the class * with {@link ConfigurationSerialization#registerClass(Class)}. diff --git a/src/main/java/org/bukkit/entity/CreatureType.java b/src/main/java/org/bukkit/entity/CreatureType.java index 48ff687a..127d4756 100644 --- a/src/main/java/org/bukkit/entity/CreatureType.java +++ b/src/main/java/org/bukkit/entity/CreatureType.java @@ -71,6 +71,7 @@ public enum CreatureType { /** * + * @return the raw type id * @deprecated Magic value */ @Deprecated @@ -84,6 +85,8 @@ public enum CreatureType { /** * + * @param id the raw type id + * @return the matching CreatureType or null * @deprecated Magic value */ @Deprecated diff --git a/src/main/java/org/bukkit/entity/Damageable.java b/src/main/java/org/bukkit/entity/Damageable.java index 53877a84..d0599cf0 100644 --- a/src/main/java/org/bukkit/entity/Damageable.java +++ b/src/main/java/org/bukkit/entity/Damageable.java @@ -15,6 +15,8 @@ public interface Damageable extends Entity { * This method exists for legacy reasons to provide backwards * compatibility. It will not exist at runtime and should not be used * under any circumstances. + * + * @param amount Amount of damage to deal */ @Deprecated void _INVALID_damage(int amount); @@ -32,6 +34,9 @@ public interface Damageable extends Entity { * This method exists for legacy reasons to provide backwards * compatibility. It will not exist at runtime and should not be used * under any circumstances. + * + * @param amount Amount of damage to deal + * @param source Entity which to attribute this damage from */ @Deprecated void _INVALID_damage(int amount, Entity source); @@ -47,6 +52,8 @@ public interface Damageable extends Entity { * This method exists for legacy reasons to provide backwards * compatibility. It will not exist at runtime and should not be used * under any circumstances. + * + * @return Health represented from 0 to max */ @Deprecated int _INVALID_getHealth(); @@ -56,7 +63,7 @@ public interface Damageable extends Entity { * dead. * * @param health New health represented from 0 to max - * @throws IllegalArgumentException Thrown if the health is < 0 or > + * @throws IllegalArgumentException Thrown if the health is {@literal < 0 or >} * {@link #getMaxHealth()} */ void setHealth(double health); @@ -65,6 +72,10 @@ public interface Damageable extends Entity { * This method exists for legacy reasons to provide backwards * compatibility. It will not exist at runtime and should not be used * under any circumstances. + * + * @param health New health represented from 0 to max + * @throws IllegalArgumentException Thrown if the health is {@literal < 0 or >} + * {@link #getMaxHealth()} */ @Deprecated void _INVALID_setHealth(int health); @@ -80,6 +91,8 @@ public interface Damageable extends Entity { * This method exists for legacy reasons to provide backwards * compatibility. It will not exist at runtime and should not be used * under any circumstances. + * + * @return Maximum health */ @Deprecated int _INVALID_getMaxHealth(); @@ -101,6 +114,8 @@ public interface Damageable extends Entity { * This method exists for legacy reasons to provide backwards * compatibility. It will not exist at runtime and should not be used * under any circumstances. + * + * @param health amount of health to set the maximum to */ @Deprecated void _INVALID_setMaxHealth(int health); diff --git a/src/main/java/org/bukkit/entity/Entity.java b/src/main/java/org/bukkit/entity/Entity.java index 39c35c05..9fa886f6 100644 --- a/src/main/java/org/bukkit/entity/Entity.java +++ b/src/main/java/org/bukkit/entity/Entity.java @@ -30,6 +30,7 @@ public interface Entity extends Metadatable { * If the provided Location is null this method does nothing and returns * null. * + * @param loc the location to copy into * @return The Location object provided or null */ public Location getLocation(Location loc); @@ -109,7 +110,7 @@ public interface Entity extends Metadatable { * @param x 1/2 the size of the box along x axis * @param y 1/2 the size of the box along y axis * @param z 1/2 the size of the box along z axis - * @return List List of entities nearby + * @return {@code List} List of entities nearby */ public List getNearbyEntities(double x, double y, double z); diff --git a/src/main/java/org/bukkit/entity/EntityType.java b/src/main/java/org/bukkit/entity/EntityType.java index 2a69367d..ccc024bf 100644 --- a/src/main/java/org/bukkit/entity/EntityType.java +++ b/src/main/java/org/bukkit/entity/EntityType.java @@ -209,6 +209,7 @@ public enum EntityType { /** * + * @return the entity type's name * @deprecated Magic value */ @Deprecated @@ -222,6 +223,7 @@ public enum EntityType { /** * + * @return the raw type id * @deprecated Magic value */ @Deprecated @@ -231,6 +233,8 @@ public enum EntityType { /** * + * @param name the entity type's name + * @return the matching entity type or null * @deprecated Magic value */ @Deprecated @@ -243,6 +247,8 @@ public enum EntityType { /** * + * @param id the raw type id + * @return the matching entity type or null * @deprecated Magic value */ @Deprecated diff --git a/src/main/java/org/bukkit/entity/LivingEntity.java b/src/main/java/org/bukkit/entity/LivingEntity.java index 5e2a41ae..a0fefd85 100644 --- a/src/main/java/org/bukkit/entity/LivingEntity.java +++ b/src/main/java/org/bukkit/entity/LivingEntity.java @@ -173,6 +173,8 @@ public interface LivingEntity extends Entity, Damageable, ProjectileSource { * This method exists for legacy reasons to provide backwards * compatibility. It will not exist at runtime and should not be used * under any circumstances. + * + * @return damage taken since the last no damage ticks time period */ @Deprecated public int _INVALID_getLastDamage(); @@ -188,6 +190,8 @@ public interface LivingEntity extends Entity, Damageable, ProjectileSource { * This method exists for legacy reasons to provide backwards * compatibility. It will not exist at runtime and should not be used * under any circumstances. + * + * @param damage amount of damage */ @Deprecated public void _INVALID_setLastDamage(int damage); diff --git a/src/main/java/org/bukkit/entity/Minecart.java b/src/main/java/org/bukkit/entity/Minecart.java index a7bb0944..0b3e7745 100644 --- a/src/main/java/org/bukkit/entity/Minecart.java +++ b/src/main/java/org/bukkit/entity/Minecart.java @@ -11,6 +11,8 @@ public interface Minecart extends Vehicle { * This method exists for legacy reasons to provide backwards * compatibility. It will not exist at runtime and should not be used * under any circumstances. + * + * @param damage over 40 to "kill" a minecart */ @Deprecated public void _INVALID_setDamage(int damage); @@ -26,6 +28,8 @@ public interface Minecart extends Vehicle { * This method exists for legacy reasons to provide backwards * compatibility. It will not exist at runtime and should not be used * under any circumstances. + * + * @return The damage */ @Deprecated public int _INVALID_getDamage(); diff --git a/src/main/java/org/bukkit/entity/Player.java b/src/main/java/org/bukkit/entity/Player.java index fe8a0bd7..229a71a0 100644 --- a/src/main/java/org/bukkit/entity/Player.java +++ b/src/main/java/org/bukkit/entity/Player.java @@ -255,6 +255,7 @@ public interface Player extends HumanEntity, Conversable, CommandSender, Offline /** * Plays an effect to just this player. * + * @param the data based based on the type of the effect * @param loc the location to play the effect at * @param effect the {@link Effect} * @param data a data bit needed for some effects @@ -360,6 +361,7 @@ public interface Player extends HumanEntity, Conversable, CommandSender, Offline /** * Gets whether this player has the given achievement. * + * @param achievement the achievement to check * @return whether the player has the achievement * @throws IllegalArgumentException if achievement is null */ @@ -763,7 +765,7 @@ public interface Player extends HumanEntity, Conversable, CommandSender, Offline * Gets the players current saturation level. *

    * Saturation is a buffer for food level. Your food level will not drop if - * you are saturated > 0. + * you are saturated {@literal >} 0. * * @return Saturation level */ diff --git a/src/main/java/org/bukkit/entity/Projectile.java b/src/main/java/org/bukkit/entity/Projectile.java index 90ce3b3f..a5599fa3 100644 --- a/src/main/java/org/bukkit/entity/Projectile.java +++ b/src/main/java/org/bukkit/entity/Projectile.java @@ -11,6 +11,8 @@ public interface Projectile extends Entity { * This method exists for legacy reasons to provide backwards * compatibility. It will not exist at runtime and should not be used * under any circumstances. + * + * @return the {@link LivingEntity} that shot this projectile */ @Deprecated public LivingEntity _INVALID_getShooter(); @@ -26,6 +28,8 @@ public interface Projectile extends Entity { * This method exists for legacy reasons to provide backwards * compatibility. It will not exist at runtime and should not be used * under any circumstances. + * + * @param shooter the {@link LivingEntity} that shot this projectile */ @Deprecated public void _INVALID_setShooter(LivingEntity shooter); diff --git a/src/main/java/org/bukkit/event/EventHandler.java b/src/main/java/org/bukkit/event/EventHandler.java index e42acc19..4c9fb3cd 100644 --- a/src/main/java/org/bukkit/event/EventHandler.java +++ b/src/main/java/org/bukkit/event/EventHandler.java @@ -24,6 +24,8 @@ public @interface EventHandler { *

  • HIGHEST *
  • MONITOR * + * + * @return the priority */ EventPriority priority() default EventPriority.NORMAL; @@ -32,6 +34,8 @@ public @interface EventHandler { *

    * If ignoreCancelled is true and the event is cancelled, the method is * not called. Otherwise, the method is always called. + * + * @return whether cancelled events should be ignored */ boolean ignoreCancelled() default false; } diff --git a/src/main/java/org/bukkit/event/block/BlockCanBuildEvent.java b/src/main/java/org/bukkit/event/block/BlockCanBuildEvent.java index 3860f443..613feb91 100644 --- a/src/main/java/org/bukkit/event/block/BlockCanBuildEvent.java +++ b/src/main/java/org/bukkit/event/block/BlockCanBuildEvent.java @@ -29,6 +29,9 @@ public class BlockCanBuildEvent extends BlockEvent { /** * * @deprecated Magic value + * @param block the block involved in this event + * @param id the id of the block to place + * @param canBuild whether we can build */ @Deprecated public BlockCanBuildEvent(final Block block, final int id, final boolean canBuild) { diff --git a/src/main/java/org/bukkit/event/block/BlockIgniteEvent.java b/src/main/java/org/bukkit/event/block/BlockIgniteEvent.java index 733a15ec..5ea8b07f 100644 --- a/src/main/java/org/bukkit/event/block/BlockIgniteEvent.java +++ b/src/main/java/org/bukkit/event/block/BlockIgniteEvent.java @@ -19,10 +19,6 @@ public class BlockIgniteEvent extends BlockEvent implements Cancellable { private final Block ignitingBlock; private boolean cancel; - /** - * @deprecated use {@link BlockIgniteEvent#BlockIgniteEvent(Block, - * IgniteCause, Entity)} instead. - */ @Deprecated public BlockIgniteEvent(final Block theBlock, final IgniteCause cause, final Player thePlayer) { this(theBlock, cause, (Entity) thePlayer); diff --git a/src/main/java/org/bukkit/event/block/BlockPhysicsEvent.java b/src/main/java/org/bukkit/event/block/BlockPhysicsEvent.java index e05d1caa..01a545b4 100644 --- a/src/main/java/org/bukkit/event/block/BlockPhysicsEvent.java +++ b/src/main/java/org/bukkit/event/block/BlockPhysicsEvent.java @@ -16,6 +16,8 @@ public class BlockPhysicsEvent extends BlockEvent implements Cancellable { /** * * @deprecated Magic value + * @param block the block involved in this event + * @param changed the changed block's type id */ @Deprecated public BlockPhysicsEvent(final Block block, final int changed) { diff --git a/src/main/java/org/bukkit/event/block/SignChangeEvent.java b/src/main/java/org/bukkit/event/block/SignChangeEvent.java index d1b7908d..83188cf5 100644 --- a/src/main/java/org/bukkit/event/block/SignChangeEvent.java +++ b/src/main/java/org/bukkit/event/block/SignChangeEvent.java @@ -46,8 +46,8 @@ public class SignChangeEvent extends BlockEvent implements Cancellable { * @param index index of the line to get * @return the String containing the line of text associated with the * provided index - * @throws IndexOutOfBoundsException thrown when the provided index is > 3 - * or < 0 + * @throws IndexOutOfBoundsException thrown when the provided index is {@literal > 3 + * or < 0} */ public String getLine(int index) throws IndexOutOfBoundsException { return lines[index]; @@ -58,8 +58,8 @@ public class SignChangeEvent extends BlockEvent implements Cancellable { * * @param index index of the line to set * @param line text to set - * @throws IndexOutOfBoundsException thrown when the provided index is > 3 - * or < 0 + * @throws IndexOutOfBoundsException thrown when the provided index is {@literal > 3 + * or < 0} */ public void setLine(int index, String line) throws IndexOutOfBoundsException { lines[index] = line; diff --git a/src/main/java/org/bukkit/event/entity/EntityDamageEvent.java b/src/main/java/org/bukkit/event/entity/EntityDamageEvent.java index 2cc07996..9ef48c84 100644 --- a/src/main/java/org/bukkit/event/entity/EntityDamageEvent.java +++ b/src/main/java/org/bukkit/event/entity/EntityDamageEvent.java @@ -63,6 +63,7 @@ public class EntityDamageEvent extends EntityEvent implements Cancellable { * event's construction. * * @param type the modifier + * @return the original damage * @throws IllegalArgumentException if type is null */ public double getOriginalDamage(DamageModifier type) throws IllegalArgumentException { @@ -79,6 +80,7 @@ public class EntityDamageEvent extends EntityEvent implements Cancellable { /** * Sets the damage for the specified modifier. * + * @param type the damage modifier * @param damage the scalar value of the damage's modifier * @see #getFinalDamage() * @throws IllegalArgumentException if type is null @@ -96,6 +98,7 @@ public class EntityDamageEvent extends EntityEvent implements Cancellable { /** * Gets the damage change for some modifier * + * @param type the damage modifier * @return The raw amount of damage caused by the event * @throws IllegalArgumentException if type is null * @see DamageModifier#BASE @@ -150,6 +153,8 @@ public class EntityDamageEvent extends EntityEvent implements Cancellable { * This method exists for legacy reasons to provide backwards * compatibility. It will not exist at runtime and should not be used * under any circumstances. + * + * @return the (rounded) damage */ @Deprecated public int _INVALID_getDamage() { @@ -197,6 +202,8 @@ public class EntityDamageEvent extends EntityEvent implements Cancellable { * This method exists for legacy reasons to provide backwards * compatibility. It will not exist at runtime and should not be used * under any circumstances. + * + * @param damage the new damage value */ @Deprecated public void _INVALID_setDamage(int damage) { diff --git a/src/main/java/org/bukkit/event/entity/EntityPortalExitEvent.java b/src/main/java/org/bukkit/event/entity/EntityPortalExitEvent.java index 682fe590..41edef6b 100644 --- a/src/main/java/org/bukkit/event/entity/EntityPortalExitEvent.java +++ b/src/main/java/org/bukkit/event/entity/EntityPortalExitEvent.java @@ -26,7 +26,7 @@ public class EntityPortalExitEvent extends EntityTeleportEvent { * Gets a copy of the velocity that the entity has before entering the * portal. * - * @return velocity of entity before entering portal + * @return velocity of entity before entering the portal */ public Vector getBefore() { return this.before.clone(); @@ -36,7 +36,7 @@ public class EntityPortalExitEvent extends EntityTeleportEvent { * Gets a copy of the velocity that the entity will have after exiting the * portal. * - * @return velocity of entity after exiting portal + * @return velocity of entity after exiting the portal */ public Vector getAfter() { return this.after.clone(); @@ -44,6 +44,8 @@ public class EntityPortalExitEvent extends EntityTeleportEvent { /** * Sets the velocity that the entity will have after exiting the portal. + * + * @param after the velocity after exiting the portal */ public void setAfter(Vector after) { this.after = after.clone(); diff --git a/src/main/java/org/bukkit/event/entity/EntityRegainHealthEvent.java b/src/main/java/org/bukkit/event/entity/EntityRegainHealthEvent.java index b4291b07..a7b3517a 100644 --- a/src/main/java/org/bukkit/event/entity/EntityRegainHealthEvent.java +++ b/src/main/java/org/bukkit/event/entity/EntityRegainHealthEvent.java @@ -38,6 +38,8 @@ public class EntityRegainHealthEvent extends EntityEvent implements Cancellable * This method exists for legacy reasons to provide backwards * compatibility. It will not exist at runtime and should not be used * under any circumstances. + * + * @return the (rounded) amount regained */ @Deprecated public int _INVALID_getAmount() { @@ -57,16 +59,20 @@ public class EntityRegainHealthEvent extends EntityEvent implements Cancellable * This method exists for legacy reasons to provide backwards * compatibility. It will not exist at runtime and should not be used * under any circumstances. + * + * @param amount the amount that will be regained */ @Deprecated public void _INVALID_setAmount(int amount) { setAmount(amount); } + @Override public boolean isCancelled() { return cancelled; } + @Override public void setCancelled(boolean cancel) { cancelled = cancel; } diff --git a/src/main/java/org/bukkit/event/player/PlayerFishEvent.java b/src/main/java/org/bukkit/event/player/PlayerFishEvent.java index 7416a0ae..5f1ecfef 100644 --- a/src/main/java/org/bukkit/event/player/PlayerFishEvent.java +++ b/src/main/java/org/bukkit/event/player/PlayerFishEvent.java @@ -20,9 +20,9 @@ public class PlayerFishEvent extends PlayerEvent implements Cancellable { /** * @deprecated replaced by {@link #PlayerFishEvent(Player, Entity, Fish, * State)} to include the {@link Fish} hook entity. - * @param player - * @param entity - * @param state + * @param player the player fishing + * @param entity the caught entity + * @param state the state of fishing */ @Deprecated public PlayerFishEvent(final Player player, final Entity entity, final State state) { @@ -40,7 +40,7 @@ public class PlayerFishEvent extends PlayerEvent implements Cancellable { * Gets the entity caught by the player. *

    * If player has fished successfully, the result may be cast to {@link - * Item}. + * org.bukkit.entity.Item}. * * @return Entity caught by the player, Entity if fishing, and null if * bobber has gotten stuck in the ground or nothing has been caught diff --git a/src/main/java/org/bukkit/event/player/PlayerLoginEvent.java b/src/main/java/org/bukkit/event/player/PlayerLoginEvent.java index b74b7b89..68834ddd 100644 --- a/src/main/java/org/bukkit/event/player/PlayerLoginEvent.java +++ b/src/main/java/org/bukkit/event/player/PlayerLoginEvent.java @@ -17,6 +17,7 @@ public class PlayerLoginEvent extends PlayerEvent { /** * @deprecated Address should be provided in other constructor + * @param player The {@link Player} for this event */ @Deprecated public PlayerLoginEvent(final Player player) { @@ -25,6 +26,8 @@ public class PlayerLoginEvent extends PlayerEvent { /** * @deprecated Address should be provided in other constructor + * @param player The {@link Player} for this event + * @param hostname The hostname that was used to connect to the server */ @Deprecated public PlayerLoginEvent(final Player player, final String hostname) { @@ -49,6 +52,9 @@ public class PlayerLoginEvent extends PlayerEvent { /** * @deprecated Address and hostname should be provided in other * constructor + * @param player The {@link Player} for this event + * @param result The result status for this event + * @param message The message to be displayed if result denies login */ @Deprecated public PlayerLoginEvent(final Player player, final Result result, final String message) { diff --git a/src/main/java/org/bukkit/event/server/ServerListPingEvent.java b/src/main/java/org/bukkit/event/server/ServerListPingEvent.java index c61afdf7..343f238f 100644 --- a/src/main/java/org/bukkit/event/server/ServerListPingEvent.java +++ b/src/main/java/org/bukkit/event/server/ServerListPingEvent.java @@ -32,6 +32,10 @@ public class ServerListPingEvent extends ServerEvent implements Iterable * This constructor is intended for implementations that provide the * {@link #iterator()} method, thus provided the {@link #getNumPlayers()} * count. + * + * @param address the address of the pinger + * @param motd the message of the day + * @param maxPlayers the max number of players */ protected ServerListPingEvent(final InetAddress address, final String motd, final int maxPlayers) { this.numPlayers = MAGIC_PLAYER_COUNT; diff --git a/src/main/java/org/bukkit/event/vehicle/VehicleDamageEvent.java b/src/main/java/org/bukkit/event/vehicle/VehicleDamageEvent.java index 304ee2cb..c7b9c1a6 100644 --- a/src/main/java/org/bukkit/event/vehicle/VehicleDamageEvent.java +++ b/src/main/java/org/bukkit/event/vehicle/VehicleDamageEvent.java @@ -48,6 +48,8 @@ public class VehicleDamageEvent extends VehicleEvent implements Cancellable { * This method exists for legacy reasons to provide backwards * compatibility. It will not exist at runtime and should not be used * under any circumstances. + * + * @return the damage */ @Deprecated public int _INVALID_getDamage() { @@ -67,6 +69,8 @@ public class VehicleDamageEvent extends VehicleEvent implements Cancellable { * This method exists for legacy reasons to provide backwards * compatibility. It will not exist at runtime and should not be used * under any circumstances. + * + * @param damage the damage */ @Deprecated public void _INVALID_setDamage(int damage) { diff --git a/src/main/java/org/bukkit/event/world/StructureGrowEvent.java b/src/main/java/org/bukkit/event/world/StructureGrowEvent.java index d1c9822a..62d300d7 100644 --- a/src/main/java/org/bukkit/event/world/StructureGrowEvent.java +++ b/src/main/java/org/bukkit/event/world/StructureGrowEvent.java @@ -9,8 +9,8 @@ import org.bukkit.event.Cancellable; import org.bukkit.event.HandlerList; /** - * Event that is called when an organic structure attempts to grow (Sapling -> - * Tree), (Mushroom -> Huge Mushroom), naturally or using bonemeal. + * Event that is called when an organic structure attempts to grow (Sapling {@literal ->} + * Tree), (Mushroom {@literal ->} Huge Mushroom), naturally or using bonemeal. */ public class StructureGrowEvent extends WorldEvent implements Cancellable { private static final HandlerList handlers = new HandlerList(); diff --git a/src/main/java/org/bukkit/generator/ChunkGenerator.java b/src/main/java/org/bukkit/generator/ChunkGenerator.java index 8e08bdc9..e5db6497 100644 --- a/src/main/java/org/bukkit/generator/ChunkGenerator.java +++ b/src/main/java/org/bukkit/generator/ChunkGenerator.java @@ -89,7 +89,7 @@ public abstract class ChunkGenerator { * 

          *     short[][] result = new short[world-height / 16][];
      *
    - * Each section (sectionID = (Y>>4)) that has blocks needs to be allocated + * Each section {@code (sectionID = (Y>>4))} that has blocks needs to be allocated * space for the 4096 blocks in that section: * 
          *     result[sectionID] = new short[4096];
@@ -100,20 +100,20 @@ public abstract class ChunkGenerator {
      * following mapping function:
      * 
          *    void setBlock(short[][] result, int x, int y, int z, short blkid) {
-     *        if (result[y >> 4] == null) {
-     *            result[y >> 4] = new short[4096];
+     *        {@code if (result[y >> 4] == null) {}
+     *            {@code result[y >> 4] = new short[4096];}
      *        }
-     *        result[y >> 4][((y & 0xF) << 8) | (z << 4) | x] = blkid;
+     *        {@code result[y >> 4][((y & 0xF) << 8) | (z << 4) | x] = blkid;}
      *    }
      * 
    
      * while reading a block ID can be done with the following mapping
      * function:
      * 
          *    short getBlock(short[][] result, int x, int y, int z) {
-     *        if (result[y >> 4] == null) {
+     *        {@code if (result[y >> 4] == null) {}
      *            return (short)0;
      *        }
-     *        return result[y >> 4][((y & 0xF) << 8) | (z << 4) | x];
+     *        {@code return result[y >> 4][((y & 0xF) << 8) | (z << 4) | x];}
      *    }
      * 
    
      * while sections that are not populated can be left null.
@@ -122,20 +122,20 @@ public abstract class ChunkGenerator {
      * following mapping function:
      * 
          *    void setBlock(short[][] result, int x, int y, int z, short blkid) {
-     *        if (result[y >> 4) == null) {
-     *            result[y >> 4] = new short[4096];
+     *        {@code if (result[y >> 4) == null) {}
+     *            {@code result[y >> 4] = new short[4096];}
      *        }
-     *        result[y >> 4][((y & 0xF) << 8) | (z << 4) | x] = blkid;
+     *        {@code result[y >> 4][((y & 0xF) << 8) | (z << 4) | x] = blkid;}
      *    }
      * 
    
      * while reading a block ID can be done with the following mapping
      * function:
      * 
          *    short getBlock(short[][] result, int x, int y, int z) {
-     *        if (result[y >> 4) == null) {
+     *        {@code if (result[y >> 4) == null) {}
      *            return (short)0;
      *        }
-     *        return result[y >> 4][((y & 0xF) << 8) | (z << 4) | x];
+     *        {@code return result[y >> 4][((y & 0xF) << 8) | (z << 4) | x];}
      *    }
      * 
    
      * 
    
@@ -173,7 +173,7 @@ public abstract class ChunkGenerator {
      * 
          *     byte[][] result = new byte[world-height / 16][];
      * 
    
-     * Each section (sectionID = (Y>>4)) that has blocks needs to be allocated
+     * Each section {@code (sectionID = (Y>>4))} that has blocks needs to be allocated
      * space for the 4096 blocks in that section:
      * 
          *     result[sectionID] = new byte[4096];
@@ -184,20 +184,20 @@ public abstract class ChunkGenerator {
      * following mapping function:
      * 
          *    void setBlock(byte[][] result, int x, int y, int z, byte blkid) {
-     *        if (result[y >> 4) == null) {
-     *            result[y >> 4] = new byte[4096];
+     *        {@code if (result[y >> 4) == null) {}
+     *            {@code result[y >> 4] = new byte[4096];}
      *        }
-     *        result[y >> 4][((y & 0xF) << 8) | (z << 4) | x] = blkid;
+     *        {@code result[y >> 4][((y & 0xF) << 8) | (z << 4) | x] = blkid;}
      *    }
      * 
    
      * while reading a block ID can be done with the following mapping
      * function:
      * 
          *    byte getBlock(byte[][] result, int x, int y, int z) {
-     *        if (result[y >> 4) == null) {
+     *        {@code if (result[y >> 4) == null) {}
      *            return (byte)0;
      *        }
-     *        return result[y >> 4][((y & 0xF) << 8) | (z << 4) | x];
+     *        {@code return result[y >> 4][((y & 0xF) << 8) | (z << 4) | x];}
      *    }
      * 
    
      *
diff --git a/src/main/java/org/bukkit/help/HelpMap.java b/src/main/java/org/bukkit/help/HelpMap.java
index 9c1b51be..43017c84 100644
--- a/src/main/java/org/bukkit/help/HelpMap.java
+++ b/src/main/java/org/bukkit/help/HelpMap.java
@@ -7,7 +7,7 @@ import java.util.List;
  * The HelpMap tracks all help topics registered in a Bukkit server. When the
  * server starts up or is reloaded, help is processed and topics are added in
  * the following order:
- * 
    
+ * 
  * 
      
  * 
    1. General topics are loaded from the help.yml
  * 
    2. Plugins load and optionally call {@code addTopic()}
diff --git a/src/main/java/org/bukkit/inventory/EntityEquipment.java b/src/main/java/org/bukkit/inventory/EntityEquipment.java
index 9e712359..24dfd201 100644
--- a/src/main/java/org/bukkit/inventory/EntityEquipment.java
+++ b/src/main/java/org/bukkit/inventory/EntityEquipment.java
@@ -98,8 +98,8 @@ public interface EntityEquipment {
 
     /**
      * Gets the chance of the currently held item being dropped upon this
-     * creature's death
-     * 
      
+     * creature's death.
+     * 
      * 
        
      * 
      • A drop chance of 0F will never drop
      * 
      • A drop chance of 1F will always drop
@@ -111,8 +111,8 @@ public interface EntityEquipment {
 
     /**
      * Sets the chance of the item this creature is currently holding being
-     * dropped upon this creature's death
-     * 
        
+     * dropped upon this creature's death.
+     * 
      * 
          
      * 
        • A drop chance of 0F will never drop
      * 
        • A drop chance of 1F will always drop
@@ -124,8 +124,8 @@ public interface EntityEquipment {
     void setItemInHandDropChance(float chance);
 
     /**
-     * Gets the chance of the helmet being dropped upon this creature's death
-     * 
          
+     * Gets the chance of the helmet being dropped upon this creature's death.
+     * 
      * 
            
      * 
          • A drop chance of 0F will never drop
      * 
          • A drop chance of 1F will always drop
@@ -136,8 +136,8 @@ public interface EntityEquipment {
     float getHelmetDropChance();
 
     /**
-     * Sets the chance of the helmet being dropped upon this creature's death
-     * 
            
+     * Sets the chance of the helmet being dropped upon this creature's death.
+     * 
      * 
              
      * 
            • A drop chance of 0F will never drop
      * 
            • A drop chance of 1F will always drop
@@ -150,8 +150,8 @@ public interface EntityEquipment {
 
     /**
      * Gets the chance of the chest plate being dropped upon this creature's
-     * death
-     * 
              
+     * death.
+     * 
      * 
                
      * 
              • A drop chance of 0F will never drop
      * 
              • A drop chance of 1F will always drop
@@ -163,8 +163,8 @@ public interface EntityEquipment {
 
     /**
      * Sets the chance of the chest plate being dropped upon this creature's
-     * death
-     * 
                
+     * death.
+     * 
      * 
                  
      * 
                • A drop chance of 0F will never drop
      * 
                • A drop chance of 1F will always drop
@@ -177,8 +177,8 @@ public interface EntityEquipment {
 
     /**
      * Gets the chance of the leggings being dropped upon this creature's
-     * death
-     * 
                  
+     * death.
+     * 
      * 
                    
      * 
                  • A drop chance of 0F will never drop
      * 
                  • A drop chance of 1F will always drop
@@ -190,8 +190,8 @@ public interface EntityEquipment {
 
     /**
      * Sets the chance of the leggings being dropped upon this creature's
-     * death
-     * 
                    
+     * death.
+     * 
      * 
                      
      * 
                    • A drop chance of 0F will never drop
      * 
                    • A drop chance of 1F will always drop
@@ -203,8 +203,8 @@ public interface EntityEquipment {
     void setLeggingsDropChance(float chance);
 
     /**
-     * Gets the chance of the boots being dropped upon this creature's death
-     * 
                      
+     * Gets the chance of the boots being dropped upon this creature's death.
+     * 
      * 
                        
      * 
                      • A drop chance of 0F will never drop
      * 
                      • A drop chance of 1F will always drop
@@ -215,8 +215,8 @@ public interface EntityEquipment {
     float getBootsDropChance();
 
     /**
-     * Sets the chance of the boots being dropped upon this creature's death
-     * 
                        
+     * Sets the chance of the boots being dropped upon this creature's death.
+     * 
      * 
                          
      * 
                        • A drop chance of 0F will never drop
      * 
                        • A drop chance of 1F will always drop
diff --git a/src/main/java/org/bukkit/inventory/InventoryView.java b/src/main/java/org/bukkit/inventory/InventoryView.java
index 7e98d528..46242f8a 100644
--- a/src/main/java/org/bukkit/inventory/InventoryView.java
+++ b/src/main/java/org/bukkit/inventory/InventoryView.java
@@ -62,6 +62,7 @@ public abstract class InventoryView {
 
         /**
          *
+         * @return the id of this view
          * @deprecated Magic value
          */
         @Deprecated
diff --git a/src/main/java/org/bukkit/inventory/ItemStack.java b/src/main/java/org/bukkit/inventory/ItemStack.java
index 6137c994..8f105d91 100644
--- a/src/main/java/org/bukkit/inventory/ItemStack.java
+++ b/src/main/java/org/bukkit/inventory/ItemStack.java
@@ -95,6 +95,10 @@ public class ItemStack implements Cloneable, ConfigurationSerializable {
     }
 
     /**
+     * @param type the raw type id
+     * @param amount the amount in the stack
+     * @param damage the damage value of the item
+     * @param data the data value or null
      * @deprecated this method uses an ambiguous data byte object
      */
     @Deprecated
@@ -109,6 +113,10 @@ public class ItemStack implements Cloneable, ConfigurationSerializable {
     }
 
     /**
+     * @param type the type
+     * @param amount the amount in the stack
+     * @param damage the damage value of the item
+     * @param data the data value or null
      * @deprecated this method uses an ambiguous data byte object
      */
     @Deprecated
diff --git a/src/main/java/org/bukkit/inventory/meta/FireworkMeta.java b/src/main/java/org/bukkit/inventory/meta/FireworkMeta.java
index 3e06ee04..1e3ee59b 100644
--- a/src/main/java/org/bukkit/inventory/meta/FireworkMeta.java
+++ b/src/main/java/org/bukkit/inventory/meta/FireworkMeta.java
@@ -57,7 +57,7 @@ public interface FireworkMeta extends ItemMeta {
      * Remove an effect from this firework.
      *
      * @param index The index of the effect to remove
-     * @throws IndexOutOfBoundsException If index < 0 or index > {@link
+     * @throws IndexOutOfBoundsException If index {@literal < 0 or index >} {@link
      *     #getEffectsSize()}
      */
     void removeEffect(int index) throws IndexOutOfBoundsException;
@@ -86,7 +86,7 @@ public interface FireworkMeta extends ItemMeta {
      * a second of flight time.
      *
      * @param power the power of the firework, from 0-128
-     * @throws IllegalArgumentException if height<0 or height>128
+     * @throws IllegalArgumentException if {@literal height<0 or height>128}
      */
     void setPower(int power) throws IllegalArgumentException;
 
diff --git a/src/main/java/org/bukkit/inventory/meta/ItemMeta.java b/src/main/java/org/bukkit/inventory/meta/ItemMeta.java
index 397ba115..00f71ce2 100644
--- a/src/main/java/org/bukkit/inventory/meta/ItemMeta.java
+++ b/src/main/java/org/bukkit/inventory/meta/ItemMeta.java
@@ -87,7 +87,7 @@ public interface ItemMeta extends Cloneable, ConfigurationSerializable {
     int getEnchantLevel(Enchantment ench);
 
     /**
-     * Returns a copy the enchantments in this ItemMeta.
                          
+     * Returns a copy the enchantments in this ItemMeta. 
                           
      * Returns an empty map if none.
      *
      * @return An immutable copy of the enchantments
diff --git a/src/main/java/org/bukkit/map/MapCursor.java b/src/main/java/org/bukkit/map/MapCursor.java
index d3698a6e..52317497 100644
--- a/src/main/java/org/bukkit/map/MapCursor.java
+++ b/src/main/java/org/bukkit/map/MapCursor.java
@@ -166,6 +166,7 @@ public final class MapCursor {
 
         /**
          *
+         * @return the value 
          * @deprecated Magic value
          */
         @Deprecated
@@ -175,6 +176,8 @@ public final class MapCursor {
 
         /**
          *
+         * @param value the value
+         * @return the matching type
          * @deprecated Magic value
          */
         @Deprecated
diff --git a/src/main/java/org/bukkit/map/MapView.java b/src/main/java/org/bukkit/map/MapView.java
index ff370f4a..65c41596 100644
--- a/src/main/java/org/bukkit/map/MapView.java
+++ b/src/main/java/org/bukkit/map/MapView.java
@@ -135,7 +135,7 @@ public interface MapView {
     /**
      * Get a list of MapRenderers currently in effect.
      *
-     * @return A List containing each map renderer.
+     * @return A {@code List} containing each map renderer.
      */
     public List getRenderers();
 
diff --git a/src/main/java/org/bukkit/material/Banner.java b/src/main/java/org/bukkit/material/Banner.java
index e5a9d1c8..80a76165 100644
--- a/src/main/java/org/bukkit/material/Banner.java
+++ b/src/main/java/org/bukkit/material/Banner.java
@@ -14,7 +14,7 @@ public class Banner extends MaterialData implements Attachable {
     }
 
     /**
-     *
+     * @param type the raw type id
      * @deprecated Magic value
      */
     @Deprecated
@@ -24,6 +24,8 @@ public class Banner extends MaterialData implements Attachable {
 
     /**
      *
+     * @param type the type
+     * @param data the raw data value
      * @deprecated Magic value
      */
     @Deprecated
@@ -31,8 +33,9 @@ public class Banner extends MaterialData implements Attachable {
         super(type, data);
     }
 
-    /**
-     *
+    /**     *
+     * @param type the raw type id
+     * @param data the raw data value
      * @deprecated Magic value
      */
     @Deprecated
diff --git a/src/main/java/org/bukkit/material/Bed.java b/src/main/java/org/bukkit/material/Bed.java
index a1c087a2..ce94dafb 100644
--- a/src/main/java/org/bukkit/material/Bed.java
+++ b/src/main/java/org/bukkit/material/Bed.java
@@ -27,6 +27,7 @@ public class Bed extends MaterialData implements Directional {
 
     /**
      *
+     * @param type the raw type id
      * @deprecated Magic value
      */
     @Deprecated
@@ -39,7 +40,8 @@ public class Bed extends MaterialData implements Directional {
     }
 
     /**
-     *
+     * @param type the raw type id
+     * @param data the raw data value
      * @deprecated Magic value
      */
     @Deprecated
@@ -48,7 +50,8 @@ public class Bed extends MaterialData implements Directional {
     }
 
     /**
-     *
+     * @param type the type
+     * @param data the raw data value
      * @deprecated Magic value
      */
     @Deprecated
diff --git a/src/main/java/org/bukkit/material/Button.java b/src/main/java/org/bukkit/material/Button.java
index 2eeeaa6b..01895918 100644
--- a/src/main/java/org/bukkit/material/Button.java
+++ b/src/main/java/org/bukkit/material/Button.java
@@ -12,7 +12,7 @@ public class Button extends SimpleAttachableMaterialData implements Redstone {
     }
 
     /**
-     *
+     * @param type the type
      * @deprecated Magic value
      */
     @Deprecated
@@ -25,7 +25,8 @@ public class Button extends SimpleAttachableMaterialData implements Redstone {
     }
 
     /**
-     *
+     * @param type the raw type id
+     * @param data the raw data value
      * @deprecated Magic value
      */
     @Deprecated
@@ -34,7 +35,8 @@ public class Button extends SimpleAttachableMaterialData implements Redstone {
     }
 
     /**
-     *
+     * @param type the type
+     * @param data the raw data value
      * @deprecated Magic value
      */
     @Deprecated
diff --git a/src/main/java/org/bukkit/material/Cake.java b/src/main/java/org/bukkit/material/Cake.java
index 360ae585..e72cb914 100644
--- a/src/main/java/org/bukkit/material/Cake.java
+++ b/src/main/java/org/bukkit/material/Cake.java
@@ -8,7 +8,7 @@ public class Cake extends MaterialData {
     }
 
     /**
-     *
+     * @param type the raw type id
      * @deprecated Magic value
      */
     @Deprecated
@@ -21,7 +21,8 @@ public class Cake extends MaterialData {
     }
 
     /**
-     *
+     * @param type the raw type id
+     * @param data the raw data value
      * @deprecated Magic value
      */
     @Deprecated
@@ -30,7 +31,8 @@ public class Cake extends MaterialData {
     }
 
     /**
-     *
+     * @param type the type
+     * @param data the raw data value
      * @deprecated Magic value
      */
     @Deprecated
diff --git a/src/main/java/org/bukkit/material/Cauldron.java b/src/main/java/org/bukkit/material/Cauldron.java
index b464bbdb..0ead402b 100644
--- a/src/main/java/org/bukkit/material/Cauldron.java
+++ b/src/main/java/org/bukkit/material/Cauldron.java
@@ -15,6 +15,8 @@ public class Cauldron extends MaterialData {
 
     /**
      *
+     * @param type the raw type id
+     * @param data the raw data value
      * @deprecated Magic value
      */
     @Deprecated
@@ -24,6 +26,7 @@ public class Cauldron extends MaterialData {
 
     /**
      *
+     * @param data the raw data value
      * @deprecated Magic value
      */
     @Deprecated
diff --git a/src/main/java/org/bukkit/material/Chest.java b/src/main/java/org/bukkit/material/Chest.java
index b9f69880..0db8aa54 100644
--- a/src/main/java/org/bukkit/material/Chest.java
+++ b/src/main/java/org/bukkit/material/Chest.java
@@ -23,7 +23,7 @@ public class Chest extends DirectionalContainer {
     }
 
     /**
-     *
+     * @param type the raw type id
      * @deprecated Magic value
      */
     @Deprecated
@@ -36,7 +36,8 @@ public class Chest extends DirectionalContainer {
     }
 
     /**
-     *
+     * @param type the raw type id
+     * @param data the raw data value
      * @deprecated Magic value
      */
     @Deprecated
@@ -45,7 +46,8 @@ public class Chest extends DirectionalContainer {
     }
 
     /**
-     *
+     * @param type the type
+     * @param data the raw data value
      * @deprecated Magic value
      */
     @Deprecated
diff --git a/src/main/java/org/bukkit/material/Coal.java b/src/main/java/org/bukkit/material/Coal.java
index 3a4f7c38..dd940b63 100644
--- a/src/main/java/org/bukkit/material/Coal.java
+++ b/src/main/java/org/bukkit/material/Coal.java
@@ -17,7 +17,7 @@ public class Coal extends MaterialData {
     }
 
     /**
-     *
+     * @param type the raw type id
      * @deprecated Magic value
      */
     @Deprecated
@@ -30,7 +30,8 @@ public class Coal extends MaterialData {
     }
 
     /**
-     *
+     * @param type the raw type id
+     * @param data the raw data value
      * @deprecated Magic value
      */
     @Deprecated
@@ -39,7 +40,8 @@ public class Coal extends MaterialData {
     }
 
     /**
-     *
+     * @param type the type
+     * @param data the raw data value
      * @deprecated Magic value
      */
     @Deprecated
diff --git a/src/main/java/org/bukkit/material/CocoaPlant.java b/src/main/java/org/bukkit/material/CocoaPlant.java
index b8280b5b..6dede93c 100644
--- a/src/main/java/org/bukkit/material/CocoaPlant.java
+++ b/src/main/java/org/bukkit/material/CocoaPlant.java
@@ -19,7 +19,7 @@ public class CocoaPlant extends MaterialData implements Directional, Attachable
     }
 
     /**
-     *
+     * @param type the raw type id     
      * @deprecated Magic value
      */
     @Deprecated
@@ -28,7 +28,8 @@ public class CocoaPlant extends MaterialData implements Directional, Attachable
     }
 
     /**
-     *
+     * @param type the raw type id
+     * @param data the raw data value
      * @deprecated Magic value
      */
     @Deprecated
diff --git a/src/main/java/org/bukkit/material/Command.java b/src/main/java/org/bukkit/material/Command.java
index 174e1ff8..b484229e 100644
--- a/src/main/java/org/bukkit/material/Command.java
+++ b/src/main/java/org/bukkit/material/Command.java
@@ -11,7 +11,7 @@ public class Command extends MaterialData implements Redstone {
     }
 
     /**
-     *
+     * @param type the raw type id
      * @deprecated Magic value
      */
     @Deprecated
@@ -24,7 +24,8 @@ public class Command extends MaterialData implements Redstone {
     }
 
     /**
-     *
+     * @param type the raw type id
+     * @param data the raw data value
      * @deprecated Magic value
      */
     @Deprecated
@@ -33,7 +34,8 @@ public class Command extends MaterialData implements Redstone {
     }
 
     /**
-     *
+     * @param type the type
+     * @param data the raw data value
      * @deprecated Magic value
      */
     @Deprecated
diff --git a/src/main/java/org/bukkit/material/Crops.java b/src/main/java/org/bukkit/material/Crops.java
index 2791998d..0a4f8f17 100644
--- a/src/main/java/org/bukkit/material/Crops.java
+++ b/src/main/java/org/bukkit/material/Crops.java
@@ -17,7 +17,7 @@ public class Crops extends MaterialData {
     }
 
     /**
-     *
+     * @param type the raw type id
      * @deprecated Magic value
      */
     @Deprecated
@@ -30,7 +30,8 @@ public class Crops extends MaterialData {
     }
 
     /**
-     *
+     * @param type the raw type id
+     * @param data the raw data value
      * @deprecated Magic value
      */
     @Deprecated
@@ -39,7 +40,8 @@ public class Crops extends MaterialData {
     }
 
     /**
-     *
+     * @param type the type
+     * @param data the raw data value
      * @deprecated Magic value
      */
     @Deprecated
diff --git a/src/main/java/org/bukkit/material/DetectorRail.java b/src/main/java/org/bukkit/material/DetectorRail.java
index b1d3073c..652a4b5e 100644
--- a/src/main/java/org/bukkit/material/DetectorRail.java
+++ b/src/main/java/org/bukkit/material/DetectorRail.java
@@ -11,7 +11,7 @@ public class DetectorRail extends ExtendedRails implements PressureSensor {
     }
 
     /**
-     *
+     * @param type the raw type id
      * @deprecated Magic value
      */
     @Deprecated
@@ -24,7 +24,8 @@ public class DetectorRail extends ExtendedRails implements PressureSensor {
     }
 
     /**
-     *
+     * @param type the raw type id
+     * @param data the raw data value
      * @deprecated Magic value
      */
     @Deprecated
@@ -33,7 +34,8 @@ public class DetectorRail extends ExtendedRails implements PressureSensor {
     }
 
     /**
-     *
+     * @param type the type
+     * @param data the raw data value
      * @deprecated Magic value
      */
     @Deprecated
diff --git a/src/main/java/org/bukkit/material/Diode.java b/src/main/java/org/bukkit/material/Diode.java
index 04210b7a..fbfacc06 100644
--- a/src/main/java/org/bukkit/material/Diode.java
+++ b/src/main/java/org/bukkit/material/Diode.java
@@ -9,7 +9,7 @@ public class Diode extends MaterialData implements Directional {
     }
 
     /**
-     *
+     * @param type the raw type id
      * @deprecated Magic value
      */
     @Deprecated
@@ -22,7 +22,8 @@ public class Diode extends MaterialData implements Directional {
     }
 
     /**
-     *
+     * @param type the raw type id
+     * @param data the raw data value
      * @deprecated Magic value
      */
     @Deprecated
@@ -31,7 +32,8 @@ public class Diode extends MaterialData implements Directional {
     }
 
     /**
-     *
+     * @param type the type
+     * @param data the raw data value
      * @deprecated Magic value
      */
     @Deprecated
diff --git a/src/main/java/org/bukkit/material/DirectionalContainer.java b/src/main/java/org/bukkit/material/DirectionalContainer.java
index 9b0a0475..b56f0988 100644
--- a/src/main/java/org/bukkit/material/DirectionalContainer.java
+++ b/src/main/java/org/bukkit/material/DirectionalContainer.java
@@ -8,7 +8,7 @@ import org.bukkit.block.BlockFace;
  */
 public class DirectionalContainer extends MaterialData implements Directional {
     /**
-     *
+     * @param type the raw type id
      * @deprecated Magic value
      */
     @Deprecated
@@ -21,7 +21,8 @@ public class DirectionalContainer extends MaterialData implements Directional {
     }
 
     /**
-     *
+     * @param type the raw type id
+     * @param data the raw data value
      * @deprecated Magic value
      */
     @Deprecated
@@ -30,7 +31,8 @@ public class DirectionalContainer extends MaterialData implements Directional {
     }
 
     /**
-     *
+     * @param type the type
+     * @param data the raw data value
      * @deprecated Magic value
      */
     @Deprecated
diff --git a/src/main/java/org/bukkit/material/Dispenser.java b/src/main/java/org/bukkit/material/Dispenser.java
index b62f8c91..988407cf 100644
--- a/src/main/java/org/bukkit/material/Dispenser.java
+++ b/src/main/java/org/bukkit/material/Dispenser.java
@@ -18,7 +18,7 @@ public class Dispenser extends FurnaceAndDispenser {
     }
 
     /**
-     *
+     * @param type the raw type id
      * @deprecated Magic value
      */
     @Deprecated
@@ -31,7 +31,8 @@ public class Dispenser extends FurnaceAndDispenser {
     }
 
     /**
-     *
+     * @param type the raw type id
+     * @param data the raw data value
      * @deprecated Magic value
      */
     @Deprecated
@@ -40,7 +41,8 @@ public class Dispenser extends FurnaceAndDispenser {
     }
 
     /**
-     *
+     * @param type the type
+     * @param data the raw data value
      * @deprecated Magic value
      */
     @Deprecated
diff --git a/src/main/java/org/bukkit/material/Door.java b/src/main/java/org/bukkit/material/Door.java
index 65fa32ca..0c5b52f0 100644
--- a/src/main/java/org/bukkit/material/Door.java
+++ b/src/main/java/org/bukkit/material/Door.java
@@ -15,7 +15,7 @@ public class Door extends MaterialData implements Directional, Openable {
     }
 
     /**
-     *
+     * @param type the raw type id
      * @deprecated Magic value
      */
     @Deprecated
@@ -28,7 +28,8 @@ public class Door extends MaterialData implements Directional, Openable {
     }
 
     /**
-     *
+     * @param type the raw type id
+     * @param data the raw data value
      * @deprecated Magic value
      */
     @Deprecated
@@ -37,7 +38,8 @@ public class Door extends MaterialData implements Directional, Openable {
     }
 
     /**
-     *
+     * @param type the type
+     * @param data the raw data value
      * @deprecated Magic value
      */
     @Deprecated
diff --git a/src/main/java/org/bukkit/material/Dye.java b/src/main/java/org/bukkit/material/Dye.java
index 4412c1f5..0857dd86 100644
--- a/src/main/java/org/bukkit/material/Dye.java
+++ b/src/main/java/org/bukkit/material/Dye.java
@@ -12,7 +12,7 @@ public class Dye extends MaterialData implements Colorable {
     }
 
     /**
-     *
+     * @param type the raw type id
      * @deprecated Magic value
      */
     @Deprecated
@@ -25,7 +25,8 @@ public class Dye extends MaterialData implements Colorable {
     }
 
     /**
-     *
+     * @param type the raw type id
+     * @param data the raw data value
      * @deprecated Magic value
      */
     @Deprecated
@@ -34,7 +35,8 @@ public class Dye extends MaterialData implements Colorable {
     }
 
     /**
-     *
+     * @param type the type
+     * @param data the raw data value
      * @deprecated Magic value
      */
     @Deprecated
diff --git a/src/main/java/org/bukkit/material/EnderChest.java b/src/main/java/org/bukkit/material/EnderChest.java
index 696dc65d..d3a60196 100644
--- a/src/main/java/org/bukkit/material/EnderChest.java
+++ b/src/main/java/org/bukkit/material/EnderChest.java
@@ -23,7 +23,7 @@ public class EnderChest extends DirectionalContainer {
     }
 
     /**
-     *
+     * @param type the raw type id
      * @deprecated Magic value
      */
     @Deprecated
@@ -36,7 +36,8 @@ public class EnderChest extends DirectionalContainer {
     }
 
     /**
-     *
+     * @param type the raw type id
+     * @param data the raw data value
      * @deprecated Magic value
      */
     @Deprecated
@@ -45,7 +46,8 @@ public class EnderChest extends DirectionalContainer {
     }
 
     /**
-     *
+     * @param type the type
+     * @param data the raw data value
      * @deprecated Magic value
      */
     @Deprecated
diff --git a/src/main/java/org/bukkit/material/ExtendedRails.java b/src/main/java/org/bukkit/material/ExtendedRails.java
index 0dbbf7c8..34fb55e1 100644
--- a/src/main/java/org/bukkit/material/ExtendedRails.java
+++ b/src/main/java/org/bukkit/material/ExtendedRails.java
@@ -9,7 +9,7 @@ import org.bukkit.block.BlockFace;
  */
 public class ExtendedRails extends Rails {
     /**
-     *
+     * @param type the raw type id
      * @deprecated Magic value
      */
     @Deprecated
@@ -22,7 +22,8 @@ public class ExtendedRails extends Rails {
     }
 
     /**
-     *
+     * @param type the raw type id
+     * @param data the raw data value
      * @deprecated Magic value
      */
     @Deprecated
@@ -31,7 +32,8 @@ public class ExtendedRails extends Rails {
     }
 
     /**
-     *
+     * @param type the type
+     * @param data the raw data value
      * @deprecated Magic value
      */
     @Deprecated
diff --git a/src/main/java/org/bukkit/material/FlowerPot.java b/src/main/java/org/bukkit/material/FlowerPot.java
index 787c58d2..7f3574eb 100644
--- a/src/main/java/org/bukkit/material/FlowerPot.java
+++ b/src/main/java/org/bukkit/material/FlowerPot.java
@@ -17,7 +17,7 @@ public class FlowerPot extends MaterialData {
     }
 
     /**
-     *
+     * @param type the raw type id
      * @deprecated Magic value
      */
     @Deprecated
@@ -30,7 +30,8 @@ public class FlowerPot extends MaterialData {
     }
 
     /**
-     *
+     * @param type the raw type id
+     * @param data the raw data value
      * @deprecated Magic value
      */
     @Deprecated
@@ -39,7 +40,8 @@ public class FlowerPot extends MaterialData {
     }
 
     /**
-     *
+     * @param type the type
+     * @param data the raw data value
      * @deprecated Magic value
      */
     @Deprecated
diff --git a/src/main/java/org/bukkit/material/Furnace.java b/src/main/java/org/bukkit/material/Furnace.java
index 49645aa9..c607226f 100644
--- a/src/main/java/org/bukkit/material/Furnace.java
+++ b/src/main/java/org/bukkit/material/Furnace.java
@@ -23,7 +23,7 @@ public class Furnace extends FurnaceAndDispenser {
     }
 
     /**
-     *
+     * @param type the raw type id
      * @deprecated Magic value
      */
     @Deprecated
@@ -36,7 +36,8 @@ public class Furnace extends FurnaceAndDispenser {
     }
 
     /**
-     *
+     * @param type the raw type id
+     * @param data the raw data value
      * @deprecated Magic value
      */
     @Deprecated
@@ -45,7 +46,8 @@ public class Furnace extends FurnaceAndDispenser {
     }
 
     /**
-     *
+     * @param type the type
+     * @param data the raw data value
      * @deprecated Magic value
      */
     @Deprecated
diff --git a/src/main/java/org/bukkit/material/FurnaceAndDispenser.java b/src/main/java/org/bukkit/material/FurnaceAndDispenser.java
index 3665479f..184fda21 100644
--- a/src/main/java/org/bukkit/material/FurnaceAndDispenser.java
+++ b/src/main/java/org/bukkit/material/FurnaceAndDispenser.java
@@ -8,7 +8,7 @@ import org.bukkit.Material;
 public class FurnaceAndDispenser extends DirectionalContainer {
 
     /**
-     *
+     * @param type the raw type id
      * @deprecated Magic value
      */
     @Deprecated
@@ -21,7 +21,8 @@ public class FurnaceAndDispenser extends DirectionalContainer {
     }
 
     /**
-     *
+     * @param type the raw type id
+     * @param data the raw data value
      * @deprecated Magic value
      */
     @Deprecated
@@ -30,7 +31,8 @@ public class FurnaceAndDispenser extends DirectionalContainer {
     }
 
     /**
-     *
+     * @param type the type
+     * @param data the raw data value
      * @deprecated Magic value
      */
     @Deprecated
diff --git a/src/main/java/org/bukkit/material/Ladder.java b/src/main/java/org/bukkit/material/Ladder.java
index 09862bf6..cd4d6911 100644
--- a/src/main/java/org/bukkit/material/Ladder.java
+++ b/src/main/java/org/bukkit/material/Ladder.java
@@ -12,7 +12,7 @@ public class Ladder extends SimpleAttachableMaterialData {
     }
 
     /**
-     *
+     * @param type the raw type id
      * @deprecated Magic value
      */
     @Deprecated
@@ -25,7 +25,8 @@ public class Ladder extends SimpleAttachableMaterialData {
     }
 
     /**
-     *
+     * @param type the raw type id
+     * @param data the raw data value
      * @deprecated Magic value
      */
     @Deprecated
@@ -34,7 +35,8 @@ public class Ladder extends SimpleAttachableMaterialData {
     }
 
     /**
-     *
+     * @param type the type
+     * @param data the raw data value
      * @deprecated Magic value
      */
     @Deprecated
diff --git a/src/main/java/org/bukkit/material/Leaves.java b/src/main/java/org/bukkit/material/Leaves.java
index 97ba3820..9f40a23d 100644
--- a/src/main/java/org/bukkit/material/Leaves.java
+++ b/src/main/java/org/bukkit/material/Leaves.java
@@ -17,7 +17,7 @@ public class Leaves extends MaterialData {
     }
 
     /**
-     *
+     * @param type the raw type id
      * @deprecated Magic value
      */
     @Deprecated
@@ -30,7 +30,8 @@ public class Leaves extends MaterialData {
     }
 
     /**
-     *
+     * @param type the raw type id
+     * @param data the raw data value
      * @deprecated Magic value
      */
     @Deprecated
@@ -39,7 +40,8 @@ public class Leaves extends MaterialData {
     }
 
     /**
-     *
+     * @param type the type
+     * @param data the raw data value
      * @deprecated Magic value
      */
     @Deprecated
diff --git a/src/main/java/org/bukkit/material/Lever.java b/src/main/java/org/bukkit/material/Lever.java
index b88c536f..c6d3882c 100644
--- a/src/main/java/org/bukkit/material/Lever.java
+++ b/src/main/java/org/bukkit/material/Lever.java
@@ -12,7 +12,7 @@ public class Lever extends SimpleAttachableMaterialData implements Redstone {
     }
 
     /**
-     *
+     * @param type the raw type id
      * @deprecated Magic value
      */
     @Deprecated
@@ -25,7 +25,8 @@ public class Lever extends SimpleAttachableMaterialData implements Redstone {
     }
 
     /**
-     *
+     * @param type the raw type id
+     * @param data the raw data value
      * @deprecated Magic value
      */
     @Deprecated
@@ -34,7 +35,8 @@ public class Lever extends SimpleAttachableMaterialData implements Redstone {
     }
 
     /**
-     *
+     * @param type the type
+     * @param data the raw data value
      * @deprecated Magic value
      */
     @Deprecated
diff --git a/src/main/java/org/bukkit/material/LongGrass.java b/src/main/java/org/bukkit/material/LongGrass.java
index e8d1f380..5cd8d200 100644
--- a/src/main/java/org/bukkit/material/LongGrass.java
+++ b/src/main/java/org/bukkit/material/LongGrass.java
@@ -17,7 +17,7 @@ public class LongGrass extends MaterialData {
     }
 
     /**
-     *
+     * @param type the raw type id
      * @deprecated Magic value
      */
     @Deprecated
@@ -30,7 +30,8 @@ public class LongGrass extends MaterialData {
     }
 
     /**
-     *
+     * @param type the raw type id
+     * @param data the raw data value
      * @deprecated Magic value
      */
     @Deprecated
@@ -39,7 +40,8 @@ public class LongGrass extends MaterialData {
     }
 
     /**
-     *
+     * @param type the type
+     * @param data the raw data value
      * @deprecated Magic value
      */
     @Deprecated
diff --git a/src/main/java/org/bukkit/material/MaterialData.java b/src/main/java/org/bukkit/material/MaterialData.java
index ad7675f2..9caf085e 100644
--- a/src/main/java/org/bukkit/material/MaterialData.java
+++ b/src/main/java/org/bukkit/material/MaterialData.java
@@ -11,7 +11,7 @@ public class MaterialData implements Cloneable {
     private byte data = 0;
 
     /**
-     *
+     * @param type the raw type id
      * @deprecated Magic value
      */
     @Deprecated
@@ -24,7 +24,8 @@ public class MaterialData implements Cloneable {
     }
 
     /**
-     *
+     * @param type the raw type id
+     * @param data the raw data value
      * @deprecated Magic value
      */
     @Deprecated
@@ -34,7 +35,8 @@ public class MaterialData implements Cloneable {
     }
 
     /**
-     *
+     * @param type the type
+     * @param data the raw data value
      * @deprecated Magic value
      */
     @Deprecated
diff --git a/src/main/java/org/bukkit/material/MonsterEggs.java b/src/main/java/org/bukkit/material/MonsterEggs.java
index d8b627b7..a6897b7e 100644
--- a/src/main/java/org/bukkit/material/MonsterEggs.java
+++ b/src/main/java/org/bukkit/material/MonsterEggs.java
@@ -22,7 +22,7 @@ public class MonsterEggs extends TexturedMaterial {
     }
 
     /**
-     *
+     * @param type the raw type id
      * @deprecated Magic value
      */
     @Deprecated
@@ -38,7 +38,8 @@ public class MonsterEggs extends TexturedMaterial {
     }
 
     /**
-     *
+     * @param type the raw type id
+     * @param data the raw data value
      * @deprecated Magic value
      */
     @Deprecated
@@ -47,7 +48,8 @@ public class MonsterEggs extends TexturedMaterial {
     }
 
     /**
-     *
+     * @param type the type
+     * @param data the raw data value
      * @deprecated Magic value
      */
     @Deprecated
diff --git a/src/main/java/org/bukkit/material/Mushroom.java b/src/main/java/org/bukkit/material/Mushroom.java
index 716d3781..40077a6a 100644
--- a/src/main/java/org/bukkit/material/Mushroom.java
+++ b/src/main/java/org/bukkit/material/Mushroom.java
@@ -27,7 +27,8 @@ public class Mushroom extends MaterialData {
     }
 
     /**
-     *
+     * @param shroom the type
+     * @param data the raw data value
      * @deprecated Magic value
      */
     @Deprecated
@@ -37,7 +38,8 @@ public class Mushroom extends MaterialData {
     }
 
     /**
-     *
+     * @param type the raw type id
+     * @param data the raw data value
      * @deprecated Magic value
      */
     @Deprecated
diff --git a/src/main/java/org/bukkit/material/NetherWarts.java b/src/main/java/org/bukkit/material/NetherWarts.java
index 99ea3f0b..55eb864a 100644
--- a/src/main/java/org/bukkit/material/NetherWarts.java
+++ b/src/main/java/org/bukkit/material/NetherWarts.java
@@ -17,7 +17,7 @@ public class NetherWarts extends MaterialData {
     }
 
     /**
-     *
+     * @param type the raw type id
      * @deprecated Magic value
      */
     @Deprecated
@@ -30,7 +30,8 @@ public class NetherWarts extends MaterialData {
     }
 
     /**
-     *
+     * @param type the raw type id
+     * @param data the raw data value
      * @deprecated Magic value
      */
     @Deprecated
@@ -39,7 +40,8 @@ public class NetherWarts extends MaterialData {
     }
 
     /**
-     *
+     * @param type the type
+     * @param data the raw data value
      * @deprecated Magic value
      */
     @Deprecated
diff --git a/src/main/java/org/bukkit/material/PistonBaseMaterial.java b/src/main/java/org/bukkit/material/PistonBaseMaterial.java
index f3586dc0..bbf1565d 100644
--- a/src/main/java/org/bukkit/material/PistonBaseMaterial.java
+++ b/src/main/java/org/bukkit/material/PistonBaseMaterial.java
@@ -7,8 +7,11 @@ import org.bukkit.block.BlockFace;
  * Material data for the piston base block
  */
 public class PistonBaseMaterial extends MaterialData implements Directional, Redstone {
+    
     /**
-     *
+     * Constructs a PistonBaseMaterial
+     * 
+     * @param type the raw type id
      * @deprecated Magic value
      */
     @Deprecated
@@ -21,7 +24,10 @@ public class PistonBaseMaterial extends MaterialData implements Directional, Red
     }
 
     /**
-     *
+     * Constructs a PistonBaseMaterial.
+     * 
+     * @param type the raw type id
+     * @param data the raw data value
      * @deprecated Magic value
      */
     @Deprecated
@@ -30,7 +36,10 @@ public class PistonBaseMaterial extends MaterialData implements Directional, Red
     }
 
     /**
-     *
+     * Constructs a PistonBaseMaterial.
+     * 
+     * @param type the material type to use
+     * @param data the raw data value 
      * @deprecated Magic value
      */
     @Deprecated
@@ -38,6 +47,7 @@ public class PistonBaseMaterial extends MaterialData implements Directional, Red
         super(type, data);
     }
 
+    @Override
     public void setFacingDirection(BlockFace face) {
         byte data = (byte) (getData() & 0x8);
 
@@ -61,6 +71,7 @@ public class PistonBaseMaterial extends MaterialData implements Directional, Red
         setData(data);
     }
 
+    @Override
     public BlockFace getFacing() {
         byte dir = (byte) (getData() & 7);
 
@@ -82,6 +93,7 @@ public class PistonBaseMaterial extends MaterialData implements Directional, Red
         }
     }
 
+    @Override
     public boolean isPowered() {
         return (getData() & 0x8) == 0x8;
     }
@@ -89,7 +101,7 @@ public class PistonBaseMaterial extends MaterialData implements Directional, Red
     /**
      * Sets the current state of this piston
      *
-     * @param powered true if the piston is extended & powered, or false
+     * @param powered true if the piston is extended {@literal &} powered, or false
      */
     public void setPowered(boolean powered) {
         setData((byte) (powered ? (getData() | 0x8) : (getData() & ~0x8)));
diff --git a/src/main/java/org/bukkit/material/PistonExtensionMaterial.java b/src/main/java/org/bukkit/material/PistonExtensionMaterial.java
index 85dee840..8076ec97 100644
--- a/src/main/java/org/bukkit/material/PistonExtensionMaterial.java
+++ b/src/main/java/org/bukkit/material/PistonExtensionMaterial.java
@@ -8,7 +8,7 @@ import org.bukkit.block.BlockFace;
  */
 public class PistonExtensionMaterial extends MaterialData implements Attachable {
     /**
-     *
+     * @param type the raw type id
      * @deprecated Magic value
      */
     @Deprecated
@@ -21,7 +21,8 @@ public class PistonExtensionMaterial extends MaterialData implements Attachable
     }
 
     /**
-     *
+     * @param type the raw type id
+     * @param data the raw data value
      * @deprecated Magic value
      */
     @Deprecated
@@ -30,7 +31,8 @@ public class PistonExtensionMaterial extends MaterialData implements Attachable
     }
 
     /**
-     *
+     * @param type the type
+     * @param data the raw data value
      * @deprecated Magic value
      */
     @Deprecated
diff --git a/src/main/java/org/bukkit/material/PoweredRail.java b/src/main/java/org/bukkit/material/PoweredRail.java
index 444e53b7..4a9d6a97 100644
--- a/src/main/java/org/bukkit/material/PoweredRail.java
+++ b/src/main/java/org/bukkit/material/PoweredRail.java
@@ -11,7 +11,7 @@ public class PoweredRail extends ExtendedRails implements Redstone {
     }
 
     /**
-     *
+     * @param type the raw type id
      * @deprecated Magic value
      */
     @Deprecated
@@ -24,7 +24,8 @@ public class PoweredRail extends ExtendedRails implements Redstone {
     }
 
     /**
-     *
+     * @param type the raw type id
+     * @param data the raw data value
      * @deprecated Magic value
      */
     @Deprecated
@@ -33,7 +34,8 @@ public class PoweredRail extends ExtendedRails implements Redstone {
     }
 
     /**
-     *
+     * @param type the type
+     * @param data the raw data value
      * @deprecated Magic value
      */
     @Deprecated
diff --git a/src/main/java/org/bukkit/material/PressurePlate.java b/src/main/java/org/bukkit/material/PressurePlate.java
index 8c3bc759..d7747b5c 100644
--- a/src/main/java/org/bukkit/material/PressurePlate.java
+++ b/src/main/java/org/bukkit/material/PressurePlate.java
@@ -11,7 +11,7 @@ public class PressurePlate extends MaterialData implements PressureSensor {
     }
 
     /**
-     *
+     * @param type the raw type id
      * @deprecated Magic value
      */
     @Deprecated
@@ -24,7 +24,8 @@ public class PressurePlate extends MaterialData implements PressureSensor {
     }
 
     /**
-     *
+     * @param type the raw type id
+     * @param data the raw data value
      * @deprecated Magic value
      */
     @Deprecated
@@ -33,7 +34,8 @@ public class PressurePlate extends MaterialData implements PressureSensor {
     }
 
     /**
-     *
+     * @param type the type
+     * @param data the raw data value
      * @deprecated Magic value
      */
     @Deprecated
diff --git a/src/main/java/org/bukkit/material/Pumpkin.java b/src/main/java/org/bukkit/material/Pumpkin.java
index d6ca83c9..afd200a1 100644
--- a/src/main/java/org/bukkit/material/Pumpkin.java
+++ b/src/main/java/org/bukkit/material/Pumpkin.java
@@ -23,7 +23,7 @@ public class Pumpkin extends MaterialData implements Directional {
     }
 
     /**
-     *
+     * @param type the raw type id
      * @deprecated Magic value
      */
     @Deprecated
@@ -36,7 +36,8 @@ public class Pumpkin extends MaterialData implements Directional {
     }
 
     /**
-     *
+     * @param type the raw type id
+     * @param data the raw data value
      * @deprecated Magic value
      */
     @Deprecated
@@ -45,7 +46,8 @@ public class Pumpkin extends MaterialData implements Directional {
     }
 
     /**
-     *
+     * @param type the type
+     * @param data the raw data value
      * @deprecated Magic value
      */
     @Deprecated
diff --git a/src/main/java/org/bukkit/material/Rails.java b/src/main/java/org/bukkit/material/Rails.java
index 74fd95a9..10044ee8 100644
--- a/src/main/java/org/bukkit/material/Rails.java
+++ b/src/main/java/org/bukkit/material/Rails.java
@@ -13,7 +13,7 @@ public class Rails extends MaterialData {
     }
 
     /**
-     *
+     * @param type the raw type id
      * @deprecated Magic value
      */
     @Deprecated
@@ -26,7 +26,8 @@ public class Rails extends MaterialData {
     }
 
     /**
-     *
+     * @param type the raw type id
+     * @param data the raw data value
      * @deprecated Magic value
      */
     @Deprecated
@@ -35,7 +36,8 @@ public class Rails extends MaterialData {
     }
 
     /**
-     *
+     * @param type the type
+     * @param data the raw data value
      * @deprecated Magic value
      */
     @Deprecated
diff --git a/src/main/java/org/bukkit/material/RedstoneTorch.java b/src/main/java/org/bukkit/material/RedstoneTorch.java
index 76a3ddd9..45c3e47f 100644
--- a/src/main/java/org/bukkit/material/RedstoneTorch.java
+++ b/src/main/java/org/bukkit/material/RedstoneTorch.java
@@ -11,7 +11,7 @@ public class RedstoneTorch extends Torch implements Redstone {
     }
 
     /**
-     *
+     * @param type the raw type id
      * @deprecated Magic value
      */
     @Deprecated
@@ -24,7 +24,8 @@ public class RedstoneTorch extends Torch implements Redstone {
     }
 
     /**
-     *
+     * @param type the raw type id
+     * @param data the raw data value
      * @deprecated Magic value
      */
     @Deprecated
@@ -33,7 +34,8 @@ public class RedstoneTorch extends Torch implements Redstone {
     }
 
     /**
-     *
+     * @param type the type
+     * @param data the raw data value
      * @deprecated Magic value
      */
     @Deprecated
diff --git a/src/main/java/org/bukkit/material/RedstoneWire.java b/src/main/java/org/bukkit/material/RedstoneWire.java
index b429af00..d13ae4bf 100644
--- a/src/main/java/org/bukkit/material/RedstoneWire.java
+++ b/src/main/java/org/bukkit/material/RedstoneWire.java
@@ -11,7 +11,7 @@ public class RedstoneWire extends MaterialData implements Redstone {
     }
 
     /**
-     *
+     * @param type the raw type id
      * @deprecated Magic value
      */
     @Deprecated
@@ -24,7 +24,8 @@ public class RedstoneWire extends MaterialData implements Redstone {
     }
 
     /**
-     *
+     * @param type the raw type id
+     * @param data the raw data value
      * @deprecated Magic value
      */
     @Deprecated
@@ -33,7 +34,8 @@ public class RedstoneWire extends MaterialData implements Redstone {
     }
 
     /**
-     *
+     * @param type the type
+     * @param data the raw data value
      * @deprecated Magic value
      */
     @Deprecated
diff --git a/src/main/java/org/bukkit/material/Sandstone.java b/src/main/java/org/bukkit/material/Sandstone.java
index 26cbbb52..be88d43b 100644
--- a/src/main/java/org/bukkit/material/Sandstone.java
+++ b/src/main/java/org/bukkit/material/Sandstone.java
@@ -17,7 +17,7 @@ public class Sandstone extends MaterialData {
     }
 
     /**
-     *
+     * @param type the raw type id
      * @deprecated Magic value
      */
     @Deprecated
@@ -30,7 +30,8 @@ public class Sandstone extends MaterialData {
     }
 
     /**
-     *
+     * @param type the raw type id
+     * @param data the raw data value
      * @deprecated Magic value
      */
     @Deprecated
@@ -39,7 +40,8 @@ public class Sandstone extends MaterialData {
     }
 
     /**
-     *
+     * @param type the type
+     * @param data the raw data value
      * @deprecated Magic value
      */
     @Deprecated
diff --git a/src/main/java/org/bukkit/material/Sign.java b/src/main/java/org/bukkit/material/Sign.java
index e8da7aa9..0accdbce 100644
--- a/src/main/java/org/bukkit/material/Sign.java
+++ b/src/main/java/org/bukkit/material/Sign.java
@@ -12,7 +12,7 @@ public class Sign extends MaterialData implements Attachable {
     }
 
     /**
-     *
+     * @param type the raw type id
      * @deprecated Magic value
      */
     @Deprecated
@@ -25,7 +25,8 @@ public class Sign extends MaterialData implements Attachable {
     }
 
     /**
-     *
+     * @param type the raw type id
+     * @param data the raw data value
      * @deprecated Magic value
      */
     @Deprecated
@@ -34,7 +35,8 @@ public class Sign extends MaterialData implements Attachable {
     }
 
     /**
-     *
+     * @param type the raw type id
+     * @param data the raw data value
      * @deprecated Magic value
      */
     @Deprecated
diff --git a/src/main/java/org/bukkit/material/SimpleAttachableMaterialData.java b/src/main/java/org/bukkit/material/SimpleAttachableMaterialData.java
index b5703c6c..b1897b7b 100644
--- a/src/main/java/org/bukkit/material/SimpleAttachableMaterialData.java
+++ b/src/main/java/org/bukkit/material/SimpleAttachableMaterialData.java
@@ -9,7 +9,7 @@ import org.bukkit.block.BlockFace;
 public abstract class SimpleAttachableMaterialData extends MaterialData implements Attachable {
 
     /**
-     *
+     * @param type the raw type id
      * @deprecated Magic value
      */
     @Deprecated
@@ -32,7 +32,8 @@ public abstract class SimpleAttachableMaterialData extends MaterialData implemen
     }
 
     /**
-     *
+     * @param type the raw type id
+     * @param data the raw data value
      * @deprecated Magic value
      */
     @Deprecated
@@ -41,7 +42,8 @@ public abstract class SimpleAttachableMaterialData extends MaterialData implemen
     }
 
     /**
-     *
+     * @param type the type
+     * @param data the raw data value
      * @deprecated Magic value
      */
     @Deprecated
diff --git a/src/main/java/org/bukkit/material/Skull.java b/src/main/java/org/bukkit/material/Skull.java
index 6e0d71fa..659d9e95 100644
--- a/src/main/java/org/bukkit/material/Skull.java
+++ b/src/main/java/org/bukkit/material/Skull.java
@@ -22,7 +22,7 @@ public class Skull extends MaterialData implements Directional {
     }
 
     /**
-     *
+     * @param type the raw type id
      * @deprecated Magic value
      */
     @Deprecated
@@ -35,7 +35,8 @@ public class Skull extends MaterialData implements Directional {
     }
 
     /**
-     *
+     * @param type the raw type id
+     * @param data the raw data value
      * @deprecated Magic value
      */
     @Deprecated
@@ -44,7 +45,8 @@ public class Skull extends MaterialData implements Directional {
     }
 
     /**
-     *
+     * @param type the type
+     * @param data the raw data value
      * @deprecated Magic value
      */
     @Deprecated
diff --git a/src/main/java/org/bukkit/material/SmoothBrick.java b/src/main/java/org/bukkit/material/SmoothBrick.java
index b7ab6074..a6d8931e 100644
--- a/src/main/java/org/bukkit/material/SmoothBrick.java
+++ b/src/main/java/org/bukkit/material/SmoothBrick.java
@@ -23,7 +23,7 @@ public class SmoothBrick extends TexturedMaterial {
     }
 
     /**
-     *
+     * @param type the raw type id
      * @deprecated Magic value
      */
     @Deprecated
@@ -39,7 +39,8 @@ public class SmoothBrick extends TexturedMaterial {
     }
 
     /**
-     *
+     * @param type the raw type id
+     * @param data the raw data value
      * @deprecated Magic value
      */
     @Deprecated
@@ -48,7 +49,8 @@ public class SmoothBrick extends TexturedMaterial {
     }
 
     /**
-     *
+     * @param type the type
+     * @param data the raw data value
      * @deprecated Magic value
      */
     @Deprecated
diff --git a/src/main/java/org/bukkit/material/SpawnEgg.java b/src/main/java/org/bukkit/material/SpawnEgg.java
index ed973c52..42606271 100644
--- a/src/main/java/org/bukkit/material/SpawnEgg.java
+++ b/src/main/java/org/bukkit/material/SpawnEgg.java
@@ -13,7 +13,8 @@ public class SpawnEgg extends MaterialData {
     }
 
     /**
-     *
+     * @param type the raw type id
+     * @param data the raw data value
      * @deprecated Magic value
      */
     @Deprecated
@@ -22,7 +23,7 @@ public class SpawnEgg extends MaterialData {
     }
 
     /**
-     *
+     * @param data the raw data value
      * @deprecated Magic value
      */
     @Deprecated
diff --git a/src/main/java/org/bukkit/material/Stairs.java b/src/main/java/org/bukkit/material/Stairs.java
index 1f73c77c..7dde0214 100644
--- a/src/main/java/org/bukkit/material/Stairs.java
+++ b/src/main/java/org/bukkit/material/Stairs.java
@@ -9,7 +9,7 @@ import org.bukkit.block.BlockFace;
 public class Stairs extends MaterialData implements Directional {
 
     /**
-     *
+     * @param type the raw type id
      * @deprecated Magic value
      */
     @Deprecated
@@ -22,7 +22,8 @@ public class Stairs extends MaterialData implements Directional {
     }
 
     /**
-     *
+     * @param type the raw type id
+     * @param data the raw data value
      * @deprecated Magic value
      */
     @Deprecated
@@ -31,7 +32,8 @@ public class Stairs extends MaterialData implements Directional {
     }
 
     /**
-     *
+     * @param type the type
+     * @param data the raw data value
      * @deprecated Magic value
      */
     @Deprecated
diff --git a/src/main/java/org/bukkit/material/Step.java b/src/main/java/org/bukkit/material/Step.java
index 605f817c..c2ccfce4 100644
--- a/src/main/java/org/bukkit/material/Step.java
+++ b/src/main/java/org/bukkit/material/Step.java
@@ -26,7 +26,7 @@ public class Step extends TexturedMaterial {
     }
 
     /**
-     *
+     * @param type the raw type id
      * @deprecated Magic value
      */
     @Deprecated
@@ -42,7 +42,8 @@ public class Step extends TexturedMaterial {
     }
 
     /**
-     *
+     * @param type the raw type id
+     * @param data the raw data value
      * @deprecated Magic value
      */
     @Deprecated
@@ -51,7 +52,8 @@ public class Step extends TexturedMaterial {
     }
 
     /**
-     *
+     * @param type the type
+     * @param data the raw data value
      * @deprecated Magic value
      */
     @Deprecated
diff --git a/src/main/java/org/bukkit/material/TexturedMaterial.java b/src/main/java/org/bukkit/material/TexturedMaterial.java
index cfd971bd..d1b85e2e 100644
--- a/src/main/java/org/bukkit/material/TexturedMaterial.java
+++ b/src/main/java/org/bukkit/material/TexturedMaterial.java
@@ -14,7 +14,7 @@ public abstract class TexturedMaterial extends MaterialData {
     }
 
     /**
-     *
+     * @param type the raw type id
      * @deprecated Magic value
      */
     @Deprecated
@@ -23,7 +23,8 @@ public abstract class TexturedMaterial extends MaterialData {
     }
 
     /**
-     *
+     * @param type the raw type id
+     * @param data the raw data value
      * @deprecated Magic value
      */
     @Deprecated
@@ -32,7 +33,8 @@ public abstract class TexturedMaterial extends MaterialData {
     }
 
     /**
-     *
+     * @param type the type
+     * @param data the raw data value
      * @deprecated Magic value
      */
     @Deprecated
diff --git a/src/main/java/org/bukkit/material/Torch.java b/src/main/java/org/bukkit/material/Torch.java
index f03b3cf8..60be6bd1 100644
--- a/src/main/java/org/bukkit/material/Torch.java
+++ b/src/main/java/org/bukkit/material/Torch.java
@@ -12,7 +12,7 @@ public class Torch extends SimpleAttachableMaterialData {
     }
 
     /**
-     *
+     * @param type the raw type id
      * @deprecated Magic value
      */
     @Deprecated
@@ -25,7 +25,8 @@ public class Torch extends SimpleAttachableMaterialData {
     }
 
     /**
-     *
+     * @param type the raw type id
+     * @param data the raw data value
      * @deprecated Magic value
      */
     @Deprecated
@@ -34,7 +35,8 @@ public class Torch extends SimpleAttachableMaterialData {
     }
 
     /**
-     *
+     * @param type the type
+     * @param data the raw data value
      * @deprecated Magic value
      */
     @Deprecated
diff --git a/src/main/java/org/bukkit/material/TrapDoor.java b/src/main/java/org/bukkit/material/TrapDoor.java
index bd4bcc2b..2ae33621 100644
--- a/src/main/java/org/bukkit/material/TrapDoor.java
+++ b/src/main/java/org/bukkit/material/TrapDoor.java
@@ -12,7 +12,7 @@ public class TrapDoor extends SimpleAttachableMaterialData implements Openable {
     }
 
     /**
-     *
+     * @param type the raw type id
      * @deprecated Magic value
      */
     @Deprecated
@@ -25,7 +25,8 @@ public class TrapDoor extends SimpleAttachableMaterialData implements Openable {
     }
 
     /**
-     *
+     * @param type the raw type id
+     * @param data the raw data value
      * @deprecated Magic value
      */
     @Deprecated
@@ -34,7 +35,8 @@ public class TrapDoor extends SimpleAttachableMaterialData implements Openable {
     }
 
     /**
-     *
+     * @param type the type
+     * @param data the raw data value
      * @deprecated Magic value
      */
     @Deprecated
diff --git a/src/main/java/org/bukkit/material/Tree.java b/src/main/java/org/bukkit/material/Tree.java
index fe568723..d90126c1 100644
--- a/src/main/java/org/bukkit/material/Tree.java
+++ b/src/main/java/org/bukkit/material/Tree.java
@@ -24,7 +24,7 @@ public class Tree extends MaterialData {
     }
 
     /**
-     *
+     * @param type the raw type id
      * @deprecated Magic value
      */
     @Deprecated
@@ -37,7 +37,8 @@ public class Tree extends MaterialData {
     }
 
     /**
-     *
+     * @param type the raw type id
+     * @param data the raw data value
      * @deprecated Magic value
      */
     @Deprecated
@@ -46,7 +47,8 @@ public class Tree extends MaterialData {
     }
 
     /**
-     *
+     * @param type the type
+     * @param data the raw data value
      * @deprecated Magic value
      */
     @Deprecated
diff --git a/src/main/java/org/bukkit/material/Tripwire.java b/src/main/java/org/bukkit/material/Tripwire.java
index 583860bc..570635d2 100644
--- a/src/main/java/org/bukkit/material/Tripwire.java
+++ b/src/main/java/org/bukkit/material/Tripwire.java
@@ -12,7 +12,7 @@ public class Tripwire extends MaterialData {
     }
 
     /**
-     *
+     * @param type the raw type id
      * @deprecated Magic value
      */
     @Deprecated
@@ -21,7 +21,8 @@ public class Tripwire extends MaterialData {
     }
 
     /**
-     *
+     * @param type the raw type id
+     * @param data the raw data value
      * @deprecated Magic value
      */
     @Deprecated
diff --git a/src/main/java/org/bukkit/material/TripwireHook.java b/src/main/java/org/bukkit/material/TripwireHook.java
index 7ad2d2ad..8ff23e9f 100644
--- a/src/main/java/org/bukkit/material/TripwireHook.java
+++ b/src/main/java/org/bukkit/material/TripwireHook.java
@@ -13,7 +13,7 @@ public class TripwireHook extends SimpleAttachableMaterialData implements Redsto
     }
 
     /**
-     *
+     * @param type the raw type id
      * @deprecated Magic value
      */
     @Deprecated
@@ -22,7 +22,8 @@ public class TripwireHook extends SimpleAttachableMaterialData implements Redsto
     }
 
     /**
-     *
+     * @param type the raw type id
+     * @param data the raw data value
      * @deprecated Magic value
      */
     @Deprecated
diff --git a/src/main/java/org/bukkit/material/Vine.java b/src/main/java/org/bukkit/material/Vine.java
index a4f7ad57..5a09667f 100644
--- a/src/main/java/org/bukkit/material/Vine.java
+++ b/src/main/java/org/bukkit/material/Vine.java
@@ -21,7 +21,8 @@ public class Vine extends MaterialData {
     }
 
     /**
-     *
+     * @param type the raw type id
+     * @param data the raw data value
      * @deprecated Magic value
      */
     @Deprecated
@@ -30,7 +31,7 @@ public class Vine extends MaterialData {
     }
 
     /**
-     *
+     * @param data the raw data value
      * @deprecated Magic value
      */
     @Deprecated
diff --git a/src/main/java/org/bukkit/material/WoodenStep.java b/src/main/java/org/bukkit/material/WoodenStep.java
index 9584e252..b07ee89b 100644
--- a/src/main/java/org/bukkit/material/WoodenStep.java
+++ b/src/main/java/org/bukkit/material/WoodenStep.java
@@ -13,7 +13,7 @@ public class WoodenStep extends MaterialData {
     }
 
     /**
-     *
+     * @param type the raw type id
      * @deprecated Magic value
      */
     @Deprecated
@@ -33,7 +33,8 @@ public class WoodenStep extends MaterialData {
     }
 
     /**
-     *
+     * @param type the raw type id
+     * @param data the raw data value
      * @deprecated Magic value
      */
     @Deprecated
@@ -42,7 +43,8 @@ public class WoodenStep extends MaterialData {
     }
 
     /**
-     *
+     * @param type the type
+     * @param data the raw data value
      * @deprecated Magic value
      */
     @Deprecated
diff --git a/src/main/java/org/bukkit/material/Wool.java b/src/main/java/org/bukkit/material/Wool.java
index 8115bdc3..c4e4bfa0 100644
--- a/src/main/java/org/bukkit/material/Wool.java
+++ b/src/main/java/org/bukkit/material/Wool.java
@@ -17,7 +17,7 @@ public class Wool extends MaterialData implements Colorable {
     }
 
     /**
-     *
+     * @param type the raw type id
      * @deprecated Magic value
      */
     @Deprecated
@@ -30,7 +30,8 @@ public class Wool extends MaterialData implements Colorable {
     }
 
     /**
-     *
+     * @param type the raw type id
+     * @param data the raw data value
      * @deprecated Magic value
      */
     @Deprecated
@@ -39,7 +40,8 @@ public class Wool extends MaterialData implements Colorable {
     }
 
     /**
-     *
+     * @param type the type
+     * @param data the raw data value
      * @deprecated Magic value
      */
     @Deprecated
diff --git a/src/main/java/org/bukkit/metadata/LazyMetadataValue.java b/src/main/java/org/bukkit/metadata/LazyMetadataValue.java
index a9546e53..564d0fab 100644
--- a/src/main/java/org/bukkit/metadata/LazyMetadataValue.java
+++ b/src/main/java/org/bukkit/metadata/LazyMetadataValue.java
@@ -56,6 +56,8 @@ public class LazyMetadataValue extends MetadataValueAdapter implements MetadataV
     /**
      * Protected special constructor used by FixedMetadataValue to bypass
      * standard setup.
+     * 
+     * @param owningPlugin the owning plugin
      */
     protected LazyMetadataValue(Plugin owningPlugin) {
         super(owningPlugin);
diff --git a/src/main/java/org/bukkit/permissions/Permission.java b/src/main/java/org/bukkit/permissions/Permission.java
index 26f6f2bb..14ec7099 100644
--- a/src/main/java/org/bukkit/permissions/Permission.java
+++ b/src/main/java/org/bukkit/permissions/Permission.java
@@ -213,7 +213,7 @@ public class Permission {
      * following keys:
      * 
                            
      * 
                          • default: Boolean true or false. If not specified, false.
-     * 
                          • children: Map of child permissions. If not
+     * 
                          • children: {@code Map} of child permissions. If not
      *     specified, empty list.
      * 
                          • description: Short string containing a very small description of
      *     this description. If not specified, empty string.
@@ -245,10 +245,11 @@ public class Permission {
      * The data may contain the following keys:
      * 
                              
      * 
                            • default: Boolean true or false. If not specified, false.
-     * 
                            • children: Map of child permissions. If not
+     * 
                            • children: {@code Map} of child permissions. If not
      *     specified, empty list.
      * 
                            • description: Short string containing a very small description of
      *     this description. If not specified, empty string.
+     * 
                            
      *
      * @param name Name of the permission
      * @param data Map of keys
@@ -265,7 +266,7 @@ public class Permission {
      * The data may contain the following keys:
      * 
                              
      * 
                            • default: Boolean true or false. If not specified, false.
-     * 
                            • children: Map of child permissions. If not
+     * 
                            • children: {@code Map} of child permissions. If not
      *     specified, empty list.
      * 
                            • description: Short string containing a very small description of
      *     this description. If not specified, empty string.
diff --git a/src/main/java/org/bukkit/plugin/PluginDescriptionFile.java b/src/main/java/org/bukkit/plugin/PluginDescriptionFile.java
index 0fd966c6..c82928ef 100644
--- a/src/main/java/org/bukkit/plugin/PluginDescriptionFile.java
+++ b/src/main/java/org/bukkit/plugin/PluginDescriptionFile.java
@@ -11,7 +11,6 @@ import java.util.Set;
 
 import org.bukkit.command.CommandExecutor;
 import org.bukkit.command.PluginCommand;
-import org.bukkit.plugin.Plugin;
 import org.bukkit.plugin.java.JavaPlugin;
 import org.bukkit.permissions.Permissible;
 import org.bukkit.permissions.Permission;
@@ -51,6 +50,7 @@ import com.google.common.collect.ImmutableSet;
  * This is a list of the possible yaml keys, with specific details included in
  * the respective method documentations:
  *
    • Property information
    PropertyDescription
    + * * * * @@ -400,7 +400,7 @@ public final class PluginDescriptionFile { *- feildmaster *- amaranth * Is equivilant to this example: - * 
    authors: [Grum, feildmaster, aramanth]
    
+     * 
    authors: [Grum, feildmaster, aramanth]
    
      *
      * @return an immutable list of the plugin's authors
      */
@@ -560,6 +560,7 @@ public final class PluginDescriptionFile {
      * aliases, can be defined at runtime using methods in {@link
      * PluginCommand} and are defined here only as a convenience.
      * 
    The description of the plugin.yml layout
    NodeMethod
    
+     * 
      * 
      *     
      *     
@@ -683,6 +684,7 @@ public final class PluginDescriptionFile {
      * 
    
      * A list of optional properties for permissions:
      * 
    The command section's description
    NodeMethod
    
+     * 
      * 
      *     
      *     
@@ -776,6 +778,8 @@ public final class PluginDescriptionFile {
      *
      * Another example, with nested definitions, can be found here.
+     * 
+     * @return the permissions this plugin will register
      */
     public List getPermissions() {
         if (permissions == null) {
@@ -817,7 +821,7 @@ public final class PluginDescriptionFile {
      * not included in the API. Any unrecognized
      * awareness (one unsupported or in a future version) will cause a dummy
      * object to be created instead of failing.
-     * 
    
+     * 
      * 
      
      * 
    • Currently only supports the enumerated values in {@link
      *     PluginAwareness.Flags}.
@@ -861,6 +865,7 @@ public final class PluginDescriptionFile {
     }
 
     /**
+     * @return unused
      * @deprecated unused
      */
     @Deprecated
@@ -1101,6 +1106,7 @@ public final class PluginDescriptionFile {
     }
 
     /**
+     * @return internal use
      * @deprecated Internal use
      */
     @Deprecated
diff --git a/src/main/java/org/bukkit/plugin/TimedRegisteredListener.java b/src/main/java/org/bukkit/plugin/TimedRegisteredListener.java
index e09234c1..164be937 100644
--- a/src/main/java/org/bukkit/plugin/TimedRegisteredListener.java
+++ b/src/main/java/org/bukkit/plugin/TimedRegisteredListener.java
@@ -76,7 +76,7 @@ public class TimedRegisteredListener extends RegisteredListener {
      * returned, such that for any event this listener has handled,
      * this.getEventClass().isAssignableFrom(event.getClass())
      * and no class this.getEventClass().isAssignableFrom(clazz)
-     * && this.getEventClass() != clazz &&
+     * {@literal && this.getEventClass() != clazz &&}
      * event.getClass().isAssignableFrom(clazz) for all handled events.
      *
      * @return the event class handled by this RegisteredListener
diff --git a/src/main/java/org/bukkit/plugin/java/JavaPlugin.java b/src/main/java/org/bukkit/plugin/java/JavaPlugin.java
index 19893f31..c961b18c 100644
--- a/src/main/java/org/bukkit/plugin/java/JavaPlugin.java
+++ b/src/main/java/org/bukkit/plugin/java/JavaPlugin.java
@@ -72,6 +72,11 @@ public abstract class JavaPlugin extends PluginBase {
      *     PluginDescriptionFile, File, File) constructor} cannot be used.
      *     
      
      *     Its existence may be temporary.
+     * @param loader the plugin loader
+     * @param server the server instance
+     * @param description the plugin's description
+     * @param dataFolder the plugin's data folder
+     * @param file the location of the plugin
      */
     @Deprecated
     protected JavaPlugin(final PluginLoader loader, final Server server, final PluginDescriptionFile description, final File dataFolder, final File file) {
@@ -321,6 +326,12 @@ public abstract class JavaPlugin extends PluginBase {
     }
 
     /**
+     * @param loader the plugin loader
+     * @param server the server instance
+     * @param description the plugin's description
+     * @param dataFolder the plugin's data folder
+     * @param file the location of the plugin
+     * @param classLoader the class loader
      * @deprecated This method is legacy and will be removed - it must be
      *     replaced by the specially provided constructor(s).
      */
@@ -492,6 +503,7 @@ public abstract class JavaPlugin extends PluginBase {
      * does not extend the class, where the intended plugin would have
      * resided in a different jar / classloader.
      *
+     * @param  a class that extends JavaPlugin
      * @param clazz the class desired
      * @return the plugin that provides and implements said class
      * @throws IllegalArgumentException if clazz is null
@@ -525,6 +537,8 @@ public abstract class JavaPlugin extends PluginBase {
      * This method provides fast access to the plugin that has provided the
      * given class.
      *
+     * @param clazz a class belonging to a plugin
+     * @return the plugin that provided the class
      * @throws IllegalArgumentException if the class is not provided by a
      *     JavaPlugin
      * @throws IllegalArgumentException if class is null
diff --git a/src/main/java/org/bukkit/plugin/java/JavaPluginLoader.java b/src/main/java/org/bukkit/plugin/java/JavaPluginLoader.java
index fb0bfba5..687029fb 100644
--- a/src/main/java/org/bukkit/plugin/java/JavaPluginLoader.java
+++ b/src/main/java/org/bukkit/plugin/java/JavaPluginLoader.java
@@ -52,6 +52,8 @@ public final class JavaPluginLoader implements PluginLoader {
 
     /**
      * This class was not meant to be constructed explicitly
+     * 
+     * @param instance the server instance
      */
     @Deprecated
     public JavaPluginLoader(Server instance) {
diff --git a/src/main/java/org/bukkit/potion/Potion.java b/src/main/java/org/bukkit/potion/Potion.java
index a358c299..8966c906 100644
--- a/src/main/java/org/bukkit/potion/Potion.java
+++ b/src/main/java/org/bukkit/potion/Potion.java
@@ -39,9 +39,10 @@ public class Potion {
     }
 
     /**
+     * @param type the type of the potion
+     * @param tier the tier of the potion
      * @deprecated In favour of {@link #Potion(PotionType, int)}
-     */
-    @SuppressWarnings("javadoc")
+     */    
     @Deprecated
     public Potion(PotionType type, Tier tier) {
         this(type, tier == Tier.TWO ? 2 : 1);
@@ -49,19 +50,24 @@ public class Potion {
     }
 
     /**
+     * @param type the type of the potion
+     * @param tier the tier of the potion
+     * @param splash whether the potion is a splash potion
      * @deprecated In favour of {@link #Potion(PotionType, int, boolean)}
      */
-    @SuppressWarnings("javadoc")
     @Deprecated
     public Potion(PotionType type, Tier tier, boolean splash) {
         this(type, tier == Tier.TWO ? 2 : 1, splash);
     }
 
     /**
+     * @param type the type of the potion
+     * @param tier the tier of the potion
+     * @param splash whether the potion is a splash potion
+     * @param extended whether the potion has an extended duration
      * @deprecated In favour of {@link #Potion(PotionType, int, boolean,
      *     boolean)}
      */
-    @SuppressWarnings("javadoc")
     @Deprecated
     public Potion(PotionType type, Tier tier, boolean splash, boolean extended) {
         this(type, tier, splash);
@@ -381,6 +387,8 @@ public class Potion {
 
     /**
      *
+     * @param damage the damage value
+     * @return the produced potion
      * @deprecated Magic value
      */
     @Deprecated
@@ -433,6 +441,7 @@ public class Potion {
 
     /**
      *
+     * @return the name id
      * @deprecated Magic value
      */
     @Deprecated
diff --git a/src/main/java/org/bukkit/potion/PotionType.java b/src/main/java/org/bukkit/potion/PotionType.java
index b9949d96..568356e3 100644
--- a/src/main/java/org/bukkit/potion/PotionType.java
+++ b/src/main/java/org/bukkit/potion/PotionType.java
@@ -32,6 +32,7 @@ public enum PotionType {
 
     /**
      *
+     * @return the damage value
      * @deprecated Magic value
      */
     @Deprecated
@@ -49,6 +50,8 @@ public enum PotionType {
 
     /**
      *
+     * @param damage the damage value
+     * @return the matching potion type or null
      * @deprecated Magic value
      */
     @Deprecated
diff --git a/src/main/java/org/bukkit/projectiles/ProjectileSource.java b/src/main/java/org/bukkit/projectiles/ProjectileSource.java
index afad8d74..cf909461 100644
--- a/src/main/java/org/bukkit/projectiles/ProjectileSource.java
+++ b/src/main/java/org/bukkit/projectiles/ProjectileSource.java
@@ -11,6 +11,7 @@ public interface ProjectileSource {
     /**
      * Launches a {@link Projectile} from the ProjectileSource.
      *
+     * @param  a projectile subclass
      * @param projectile class of the projectile to launch
      * @return the launched projectile
      */
@@ -20,6 +21,7 @@ public interface ProjectileSource {
      * Launches a {@link Projectile} from the ProjectileSource with an
      * initial velocity.
      *
+     * @param  a projectile subclass
      * @param projectile class of the projectile to launch
      * @param velocity the velocity with which to launch
      * @return the launched projectile
diff --git a/src/main/java/org/bukkit/scheduler/BukkitScheduler.java b/src/main/java/org/bukkit/scheduler/BukkitScheduler.java
index dfecafa7..6e28205f 100644
--- a/src/main/java/org/bukkit/scheduler/BukkitScheduler.java
+++ b/src/main/java/org/bukkit/scheduler/BukkitScheduler.java
@@ -21,6 +21,10 @@ public interface BukkitScheduler {
 
     /**
      * @deprecated Use {@link BukkitRunnable#runTaskLater(Plugin, long)}
+     * @param plugin Plugin that owns the task
+     * @param task Task to be executed
+     * @param delay Delay in server ticks before executing task
+     * @return Task id number (-1 if scheduling failed)
      */
     @Deprecated
     public int scheduleSyncDelayedTask(Plugin plugin, BukkitRunnable task, long delay);
@@ -38,6 +42,9 @@ public interface BukkitScheduler {
 
     /**
      * @deprecated Use {@link BukkitRunnable#runTask(Plugin)}
+     * @param plugin Plugin that owns the task
+     * @param task Task to be executed
+     * @return Task id number (-1 if scheduling failed)
      */
     @Deprecated
     public int scheduleSyncDelayedTask(Plugin plugin, BukkitRunnable task);
@@ -56,7 +63,12 @@ public interface BukkitScheduler {
     public int scheduleSyncRepeatingTask(Plugin plugin, Runnable task, long delay, long period);
 
     /**
-     * @deprecated Use {@link BukkitRunnable#runTaskTimer(Plugin, long, long)}
+     * @deprecated Use {@link BukkitRunnable#runTaskTimer(Plugin, long, long)}     *
+     * @param plugin Plugin that owns the task
+     * @param task Task to be executed
+     * @param delay Delay in server ticks before executing first repeat
+     * @param period Period in server ticks of the task
+     * @return Task id number (-1 if scheduling failed)
      */
     @Deprecated
     public int scheduleSyncRepeatingTask(Plugin plugin, BukkitRunnable task, long delay, long period);
@@ -208,6 +220,12 @@ public interface BukkitScheduler {
 
     /**
      * @deprecated Use {@link BukkitRunnable#runTask(Plugin)}
+     *
+     * @param plugin the reference to the plugin scheduling task
+     * @param task the task to be run
+     * @return a BukkitTask that contains the id number
+     * @throws IllegalArgumentException if plugin is null
+     * @throws IllegalArgumentException if task is null
      */
     @Deprecated
     public BukkitTask runTask(Plugin plugin, BukkitRunnable task) throws IllegalArgumentException;
@@ -228,6 +246,11 @@ public interface BukkitScheduler {
 
     /**
      * @deprecated Use {@link BukkitRunnable#runTaskAsynchronously(Plugin)}
+     * @param plugin the reference to the plugin scheduling task
+     * @param task the task to be run
+     * @return a BukkitTask that contains the id number
+     * @throws IllegalArgumentException if plugin is null
+     * @throws IllegalArgumentException if task is null
      */
     @Deprecated
     public BukkitTask runTaskAsynchronously(Plugin plugin, BukkitRunnable task) throws IllegalArgumentException;
@@ -247,6 +270,12 @@ public interface BukkitScheduler {
 
     /**
      * @deprecated Use {@link BukkitRunnable#runTaskLater(Plugin, long)}
+     * @param plugin the reference to the plugin scheduling task
+     * @param task the task to be run
+     * @param delay the ticks to wait before running the task
+     * @return a BukkitTask that contains the id number
+     * @throws IllegalArgumentException if plugin is null
+     * @throws IllegalArgumentException if task is null
      */
     @Deprecated
     public BukkitTask runTaskLater(Plugin plugin, BukkitRunnable task, long delay) throws IllegalArgumentException;
@@ -269,6 +298,12 @@ public interface BukkitScheduler {
 
     /**
      * @deprecated Use {@link BukkitRunnable#runTaskLaterAsynchronously(Plugin, long)}
+     * @param plugin the reference to the plugin scheduling task
+     * @param task the task to be run
+     * @param delay the ticks to wait before running the task
+     * @return a BukkitTask that contains the id number
+     * @throws IllegalArgumentException if plugin is null
+     * @throws IllegalArgumentException if task is null
      */
     @Deprecated
     public BukkitTask runTaskLaterAsynchronously(Plugin plugin, BukkitRunnable task, long delay) throws IllegalArgumentException;
@@ -289,6 +324,13 @@ public interface BukkitScheduler {
 
     /**
      * @deprecated Use {@link BukkitRunnable#runTaskTimer(Plugin, long, long)}
+     * @param plugin the reference to the plugin scheduling task
+     * @param task the task to be run
+     * @param delay the ticks to wait before running the task
+     * @param period the ticks to wait between runs
+     * @return a BukkitTask that contains the id number
+     * @throws IllegalArgumentException if plugin is null
+     * @throws IllegalArgumentException if task is null
      */
     @Deprecated
     public BukkitTask runTaskTimer(Plugin plugin, BukkitRunnable task, long delay, long period) throws IllegalArgumentException;
@@ -313,6 +355,14 @@ public interface BukkitScheduler {
 
     /**
      * @deprecated Use {@link BukkitRunnable#runTaskTimerAsynchronously(Plugin, long, long)}
+     * @param plugin the reference to the plugin scheduling task
+     * @param task the task to be run
+     * @param delay the ticks to wait before running the task for the first
+     *     time
+     * @param period the ticks to wait between runs
+     * @return a BukkitTask that contains the id number
+     * @throws IllegalArgumentException if plugin is null
+     * @throws IllegalArgumentException if task is null
      */
     @Deprecated
     public BukkitTask runTaskTimerAsynchronously(Plugin plugin, BukkitRunnable task, long delay, long period) throws IllegalArgumentException;
diff --git a/src/main/java/org/bukkit/util/StringUtil.java b/src/main/java/org/bukkit/util/StringUtil.java
index 4a8753fd..7e793930 100644
--- a/src/main/java/org/bukkit/util/StringUtil.java
+++ b/src/main/java/org/bukkit/util/StringUtil.java
@@ -9,6 +9,7 @@ public class StringUtil {
      * Copies all elements from the iterable collection of originals to the
      * collection provided.
      *
+     * @param  the collection of strings
      * @param token String to search for
      * @param originals An iterable collection of strings to filter.
      * @param collection The collection to add matches to
diff --git a/src/main/java/org/bukkit/util/io/BukkitObjectInputStream.java b/src/main/java/org/bukkit/util/io/BukkitObjectInputStream.java
index d4b28251..13725531 100644
--- a/src/main/java/org/bukkit/util/io/BukkitObjectInputStream.java
+++ b/src/main/java/org/bukkit/util/io/BukkitObjectInputStream.java
@@ -21,8 +21,7 @@ public class BukkitObjectInputStream extends ObjectInputStream {
     /**
      * Constructor provided to mirror super functionality.
      *
-     * @throws IOException
-     * @throws SecurityException
+     * @throws IOException if an I/O error occurs while reading stream heade
      * @see ObjectInputStream#ObjectInputStream()
      */
     protected BukkitObjectInputStream() throws IOException, SecurityException {
@@ -33,8 +32,8 @@ public class BukkitObjectInputStream extends ObjectInputStream {
     /**
      * Object input stream decoration constructor.
      *
-     * @param in
-     * @throws IOException
+     * @param in the input stream to wrap
+     * @throws IOException if an I/O error occurs while reading stream header
      * @see ObjectInputStream#ObjectInputStream(InputStream)
      */
     public BukkitObjectInputStream(InputStream in) throws IOException {
diff --git a/src/main/java/org/bukkit/util/io/BukkitObjectOutputStream.java b/src/main/java/org/bukkit/util/io/BukkitObjectOutputStream.java
index c11e2029..84528502 100644
--- a/src/main/java/org/bukkit/util/io/BukkitObjectOutputStream.java
+++ b/src/main/java/org/bukkit/util/io/BukkitObjectOutputStream.java
@@ -21,8 +21,7 @@ public class BukkitObjectOutputStream extends ObjectOutputStream {
     /**
      * Constructor provided to mirror super functionality.
      *
-     * @throws IOException
-     * @throws SecurityException
+     * @throws IOException if an I/O error occurs while writing stream header
      * @see ObjectOutputStream#ObjectOutputStream()
      */
     protected BukkitObjectOutputStream() throws IOException, SecurityException {
@@ -33,8 +32,8 @@ public class BukkitObjectOutputStream extends ObjectOutputStream {
     /**
      * Object output stream decoration constructor.
      *
-     * @param out
-     * @throws IOException
+     * @param out the stream to wrap
+     * @throws IOException if an I/O error occurs while writing stream header
      * @see ObjectOutputStream#ObjectOutputStream(OutputStream)
      */
     public BukkitObjectOutputStream(OutputStream out) throws IOException {
diff --git a/src/main/javadoc/org/bukkit/block/package-info.java b/src/main/javadoc/org/bukkit/block/package-info.java
index fb7719b7..dc0f36a8 100644
--- a/src/main/javadoc/org/bukkit/block/package-info.java
+++ b/src/main/javadoc/org/bukkit/block/package-info.java
@@ -1,7 +1,6 @@
 /**
  * Classes used to manipulate the voxels in a {@link org.bukkit.World world},
  * including special states.
- * 
      
  */
 package org.bukkit.block;
 
diff --git a/src/main/javadoc/org/bukkit/command/defaults/package-info.java b/src/main/javadoc/org/bukkit/command/defaults/package-info.java
index f2967308..b67dfba0 100644
--- a/src/main/javadoc/org/bukkit/command/defaults/package-info.java
+++ b/src/main/javadoc/org/bukkit/command/defaults/package-info.java
@@ -1,7 +1,6 @@
 /**
  * Commands for emulating the Minecraft commands and other necessary ones for
  * use by a Bukkit implementation.
- * 
      
  */
 package org.bukkit.command.defaults;
 
diff --git a/src/main/javadoc/org/bukkit/command/package-info.java b/src/main/javadoc/org/bukkit/command/package-info.java
index f06407a5..6428f474 100644
--- a/src/main/javadoc/org/bukkit/command/package-info.java
+++ b/src/main/javadoc/org/bukkit/command/package-info.java
@@ -1,6 +1,5 @@
 /**
  * Classes relating to handling specialized non-chat player input.
- * 
      
  */
 package org.bukkit.command;
 
diff --git a/src/main/javadoc/org/bukkit/configuration/file/package-info.java b/src/main/javadoc/org/bukkit/configuration/file/package-info.java
index 9b1161bd..4973ffc1 100644
--- a/src/main/javadoc/org/bukkit/configuration/file/package-info.java
+++ b/src/main/javadoc/org/bukkit/configuration/file/package-info.java
@@ -2,7 +2,6 @@
  * Classes dedicated facilitating {@link 
  * org.bukkit.configuration.Configuration configurations} to be read and
  * stored on the filesystem.
- * 
      
  */
 package org.bukkit.configuration.file;
 
diff --git a/src/main/javadoc/org/bukkit/configuration/package-info.java b/src/main/javadoc/org/bukkit/configuration/package-info.java
index fc439dbb..63a39650 100644
--- a/src/main/javadoc/org/bukkit/configuration/package-info.java
+++ b/src/main/javadoc/org/bukkit/configuration/package-info.java
@@ -1,6 +1,5 @@
 /**
  * Classes dedicated to handling a plugin's runtime configuration.
- * 
      
  */
 package org.bukkit.configuration;
 
diff --git a/src/main/javadoc/org/bukkit/configuration/serialization/package-info.java b/src/main/javadoc/org/bukkit/configuration/serialization/package-info.java
index b33306f2..529de2e8 100644
--- a/src/main/javadoc/org/bukkit/configuration/serialization/package-info.java
+++ b/src/main/javadoc/org/bukkit/configuration/serialization/package-info.java
@@ -2,7 +2,6 @@
  * Classes dedicated to being able to perform serialization specialized for
  * the Bukkit {@link org.bukkit.configuration.Configuration configuration}
  * implementation.
- * 
      
  */
 package org.bukkit.configuration.serialization;
 
diff --git a/src/main/javadoc/org/bukkit/conversations/package-info.java b/src/main/javadoc/org/bukkit/conversations/package-info.java
index 2259e925..d49dafaf 100644
--- a/src/main/javadoc/org/bukkit/conversations/package-info.java
+++ b/src/main/javadoc/org/bukkit/conversations/package-info.java
@@ -1,6 +1,5 @@
 /**
  * Classes dedicated to facilitate direct player-to-plugin communication.
- * 
      
  */
 package org.bukkit.conversations;
 
diff --git a/src/main/javadoc/org/bukkit/enchantments/package-info.java b/src/main/javadoc/org/bukkit/enchantments/package-info.java
index a686c828..fb67cc7e 100644
--- a/src/main/javadoc/org/bukkit/enchantments/package-info.java
+++ b/src/main/javadoc/org/bukkit/enchantments/package-info.java
@@ -2,7 +2,6 @@
  * Classes relating to the specialized enhancements to {@link
  * org.bukkit.inventory.ItemStack item stacks}, as part of the {@link
  * org.bukkit.inventory.meta.ItemMeta meta data}.
- * 
      
  */
 package org.bukkit.enchantments;
 
diff --git a/src/main/javadoc/org/bukkit/entity/minecart/package-info.java b/src/main/javadoc/org/bukkit/entity/minecart/package-info.java
index 9988caaf..342f10ba 100644
--- a/src/main/javadoc/org/bukkit/entity/minecart/package-info.java
+++ b/src/main/javadoc/org/bukkit/entity/minecart/package-info.java
@@ -1,6 +1,5 @@
 /**
  * Interfaces for various {@link org.bukkit.entity.Minecart} types.
- * 
      
  */
 package org.bukkit.entity.minecart;
 
diff --git a/src/main/javadoc/org/bukkit/entity/package-info.java b/src/main/javadoc/org/bukkit/entity/package-info.java
index 581209ba..167a830d 100644
--- a/src/main/javadoc/org/bukkit/entity/package-info.java
+++ b/src/main/javadoc/org/bukkit/entity/package-info.java
@@ -1,7 +1,6 @@
 /**
  * Interfaces for non-voxel objects that can exist in a {@link
  * org.bukkit.World world}, including all players, monsters, projectiles, etc.
- * 
      
  */
 package org.bukkit.entity;
 
diff --git a/src/main/javadoc/org/bukkit/event/block/package-info.java b/src/main/javadoc/org/bukkit/event/block/package-info.java
index dd53485b..30aec218 100644
--- a/src/main/javadoc/org/bukkit/event/block/package-info.java
+++ b/src/main/javadoc/org/bukkit/event/block/package-info.java
@@ -2,7 +2,6 @@
  * {@link org.bukkit.event.Event Events} relating to when a {@link
  * org.bukkit.block.Block block} is changed or interacts with the {@link
  * org.bukkit.World world}.
- * 
      
  */
 package org.bukkit.event.block;
 
diff --git a/src/main/javadoc/org/bukkit/event/enchantment/package-info.java b/src/main/javadoc/org/bukkit/event/enchantment/package-info.java
index 7be6f83b..e609c634 100644
--- a/src/main/javadoc/org/bukkit/event/enchantment/package-info.java
+++ b/src/main/javadoc/org/bukkit/event/enchantment/package-info.java
@@ -1,7 +1,6 @@
 /**
  * {@link org.bukkit.event.Event Events} triggered from an {@link
  * org.bukkit.inventory.EnchantingInventory enchantment table}.
- * 
      
  */
 package org.bukkit.event.enchantment;
 
diff --git a/src/main/javadoc/org/bukkit/event/entity/package-info.java b/src/main/javadoc/org/bukkit/event/entity/package-info.java
index 36a1a096..cddcd4e4 100644
--- a/src/main/javadoc/org/bukkit/event/entity/package-info.java
+++ b/src/main/javadoc/org/bukkit/event/entity/package-info.java
@@ -2,7 +2,6 @@
  * {@link org.bukkit.event.Event Events} relating to {@link
  * org.bukkit.entity.Entity entities}, excluding some directly referencing
  * some more specific entity types.
- * 
      
  */
 package org.bukkit.event.entity;
 
diff --git a/src/main/javadoc/org/bukkit/event/hanging/package-info.java b/src/main/javadoc/org/bukkit/event/hanging/package-info.java
index 63e9e7e6..bf16382b 100644
--- a/src/main/javadoc/org/bukkit/event/hanging/package-info.java
+++ b/src/main/javadoc/org/bukkit/event/hanging/package-info.java
@@ -1,7 +1,6 @@
 /**
  * {@link org.bukkit.event.Event Events} relating to {@link
  * org.bukkit.entity.Hanging entities that hang}.
- * 
      
  */
 package org.bukkit.event.hanging;
 
diff --git a/src/main/javadoc/org/bukkit/event/inventory/package-info.java b/src/main/javadoc/org/bukkit/event/inventory/package-info.java
index 7cb5a636..7dd5b699 100644
--- a/src/main/javadoc/org/bukkit/event/inventory/package-info.java
+++ b/src/main/javadoc/org/bukkit/event/inventory/package-info.java
@@ -1,7 +1,6 @@
 /**
  * {@link org.bukkit.event.Event Events} relating to {@link
  * org.bukkit.inventory.Inventory inventory} manipulation.
- * 
      
  */
 package org.bukkit.event.inventory;
 
diff --git a/src/main/javadoc/org/bukkit/event/package-info.java b/src/main/javadoc/org/bukkit/event/package-info.java
index ab3011a2..dd8baa1d 100644
--- a/src/main/javadoc/org/bukkit/event/package-info.java
+++ b/src/main/javadoc/org/bukkit/event/package-info.java
@@ -1,6 +1,5 @@
 /**
  * Classes dedicated to handling triggered code executions.
- * 
      
  */
 package org.bukkit.event;
 
diff --git a/src/main/javadoc/org/bukkit/event/painting/package-info.java b/src/main/javadoc/org/bukkit/event/painting/package-info.java
index 39a8bb7d..6c9a091b 100644
--- a/src/main/javadoc/org/bukkit/event/painting/package-info.java
+++ b/src/main/javadoc/org/bukkit/event/painting/package-info.java
@@ -2,7 +2,6 @@
  * {@link org.bukkit.event.Event Events} relating to {@link
  * org.bukkit.entity.Painting paintings}, but deprecated for more general
  * {@link org.bukkit.event.hanging hanging} events.
- * 
      
  */
 package org.bukkit.event.painting;
 
diff --git a/src/main/javadoc/org/bukkit/event/player/package-info.java b/src/main/javadoc/org/bukkit/event/player/package-info.java
index c5a49541..fb645f32 100644
--- a/src/main/javadoc/org/bukkit/event/player/package-info.java
+++ b/src/main/javadoc/org/bukkit/event/player/package-info.java
@@ -1,7 +1,6 @@
 /**
  * {@link org.bukkit.event.Event Events} relating to {@link
  * org.bukkit.entity.Player players}.
- * 
      
  */
 package org.bukkit.event.player;
 
diff --git a/src/main/javadoc/org/bukkit/event/server/package-info.java b/src/main/javadoc/org/bukkit/event/server/package-info.java
index a2e16998..b548270c 100644
--- a/src/main/javadoc/org/bukkit/event/server/package-info.java
+++ b/src/main/javadoc/org/bukkit/event/server/package-info.java
@@ -1,7 +1,6 @@
 /**
  * {@link org.bukkit.event.Event Events} relating to programmatic state
  * changes on the server.
- * 
      
  */
 package org.bukkit.event.server;
 
diff --git a/src/main/javadoc/org/bukkit/event/vehicle/package-info.java b/src/main/javadoc/org/bukkit/event/vehicle/package-info.java
index 07c470a2..b88cbcd6 100644
--- a/src/main/javadoc/org/bukkit/event/vehicle/package-info.java
+++ b/src/main/javadoc/org/bukkit/event/vehicle/package-info.java
@@ -1,7 +1,6 @@
 /**
  * {@link org.bukkit.event.Event Events} relating to {@link
  * org.bukkit.entity.Vehicle vehicular entities}.
- * 
      
  */
 package org.bukkit.event.vehicle;
 
diff --git a/src/main/javadoc/org/bukkit/event/weather/package-info.java b/src/main/javadoc/org/bukkit/event/weather/package-info.java
index f2e3f49e..edaaf9f1 100644
--- a/src/main/javadoc/org/bukkit/event/weather/package-info.java
+++ b/src/main/javadoc/org/bukkit/event/weather/package-info.java
@@ -1,6 +1,5 @@
 /**
  * {@link org.bukkit.event.Event Events} relating to weather.
- * 
      
  */
 package org.bukkit.event.weather;
 
diff --git a/src/main/javadoc/org/bukkit/event/world/package-info.java b/src/main/javadoc/org/bukkit/event/world/package-info.java
index 3b075f6d..4cbb818a 100644
--- a/src/main/javadoc/org/bukkit/event/world/package-info.java
+++ b/src/main/javadoc/org/bukkit/event/world/package-info.java
@@ -1,7 +1,6 @@
 /**
  * {@link org.bukkit.event.Event Events} triggered by various {@link
  * org.bukkit.World world} states or changes.
- * 
      
  */
 package org.bukkit.event.world;
 
diff --git a/src/main/javadoc/org/bukkit/generator/package-info.java b/src/main/javadoc/org/bukkit/generator/package-info.java
index 54d1c294..2532addf 100644
--- a/src/main/javadoc/org/bukkit/generator/package-info.java
+++ b/src/main/javadoc/org/bukkit/generator/package-info.java
@@ -1,7 +1,6 @@
 /**
  * Classes to facilitate {@link org.bukkit.World world} generation
  * implementation.
- * 
      
  */
 package org.bukkit.generator;
 
diff --git a/src/main/javadoc/org/bukkit/help/package-info.java b/src/main/javadoc/org/bukkit/help/package-info.java
index 691dfcd3..66a4aacb 100644
--- a/src/main/javadoc/org/bukkit/help/package-info.java
+++ b/src/main/javadoc/org/bukkit/help/package-info.java
@@ -1,6 +1,5 @@
 /**
  * Classes used to manipulate the default command and topic assistance system.
- * 
      
  */
 package org.bukkit.help;
 
diff --git a/src/main/javadoc/org/bukkit/inventory/meta/package-info.java b/src/main/javadoc/org/bukkit/inventory/meta/package-info.java
index f39d93a4..b80eb88b 100644
--- a/src/main/javadoc/org/bukkit/inventory/meta/package-info.java
+++ b/src/main/javadoc/org/bukkit/inventory/meta/package-info.java
@@ -1,7 +1,6 @@
 /**
  * The interfaces used when manipulating extra data can can be stored inside
  * {@link org.bukkit.inventory.ItemStack item stacks}.
- * 
      
  */
 package org.bukkit.inventory.meta;
 
diff --git a/src/main/javadoc/org/bukkit/inventory/package-info.java b/src/main/javadoc/org/bukkit/inventory/package-info.java
index 79e26ca2..8881abcc 100644
--- a/src/main/javadoc/org/bukkit/inventory/package-info.java
+++ b/src/main/javadoc/org/bukkit/inventory/package-info.java
@@ -1,6 +1,5 @@
 /**
  * Classes involved in manipulating player inventories and item interactions.
- * 
      
  */
 package org.bukkit.inventory;
 
diff --git a/src/main/javadoc/org/bukkit/map/package-info.java b/src/main/javadoc/org/bukkit/map/package-info.java
index 9e08d6e5..30de8b24 100644
--- a/src/main/javadoc/org/bukkit/map/package-info.java
+++ b/src/main/javadoc/org/bukkit/map/package-info.java
@@ -1,7 +1,6 @@
 /**
  * Classes to facilitate plugin handling of {@link org.bukkit.Material#MAP
  * map} displays.
- * 
      
  */
 package org.bukkit.map;
 
diff --git a/src/main/javadoc/org/bukkit/material/package-info.java b/src/main/javadoc/org/bukkit/material/package-info.java
index d2fa49fa..f3be435e 100644
--- a/src/main/javadoc/org/bukkit/material/package-info.java
+++ b/src/main/javadoc/org/bukkit/material/package-info.java
@@ -1,6 +1,5 @@
 /**
  * Classes that represents various voxel types and states.
- * 
      
  */
 package org.bukkit.material;
 
diff --git a/src/main/javadoc/org/bukkit/metadata/package-info.java b/src/main/javadoc/org/bukkit/metadata/package-info.java
index 44227e6a..f8e00397 100644
--- a/src/main/javadoc/org/bukkit/metadata/package-info.java
+++ b/src/main/javadoc/org/bukkit/metadata/package-info.java
@@ -1,7 +1,6 @@
 /**
  * Classes dedicated to providing a layer of plugin specified data on various
  * Minecraft concepts.
- * 
      
  */
 package org.bukkit.metadata;
 
diff --git a/src/main/javadoc/org/bukkit/package-info.java b/src/main/javadoc/org/bukkit/package-info.java
index f85c88d1..da7d9f12 100644
--- a/src/main/javadoc/org/bukkit/package-info.java
+++ b/src/main/javadoc/org/bukkit/package-info.java
@@ -1,6 +1,5 @@
 /**
  * More generalized classes in the API.
- * 
      
  */
 package org.bukkit;
 
diff --git a/src/main/javadoc/org/bukkit/permissions/package-info.java b/src/main/javadoc/org/bukkit/permissions/package-info.java
index 3a5befe2..860abc3f 100644
--- a/src/main/javadoc/org/bukkit/permissions/package-info.java
+++ b/src/main/javadoc/org/bukkit/permissions/package-info.java
@@ -1,6 +1,5 @@
 /**
  * Classes dedicated to providing binary state properties to players.
- * 
      
  */
 package org.bukkit.permissions;
 
diff --git a/src/main/javadoc/org/bukkit/plugin/java/package-info.java b/src/main/javadoc/org/bukkit/plugin/java/package-info.java
index 8d6f2a5b..c74e7093 100644
--- a/src/main/javadoc/org/bukkit/plugin/java/package-info.java
+++ b/src/main/javadoc/org/bukkit/plugin/java/package-info.java
@@ -1,7 +1,6 @@
 /**
  * Classes for handling {@link org.bukkit.plugin.Plugin plugins} written in
  * java.
- * 
      
  */
 package org.bukkit.plugin.java;
 
diff --git a/src/main/javadoc/org/bukkit/plugin/messaging/package-info.java b/src/main/javadoc/org/bukkit/plugin/messaging/package-info.java
index c94ac66c..04cb2b93 100644
--- a/src/main/javadoc/org/bukkit/plugin/messaging/package-info.java
+++ b/src/main/javadoc/org/bukkit/plugin/messaging/package-info.java
@@ -1,6 +1,5 @@
 /**
  * Classes dedicated to specialized plugin to client protocols.
- * 
      
  */
 package org.bukkit.plugin.messaging;
 
diff --git a/src/main/javadoc/org/bukkit/plugin/package-info.java b/src/main/javadoc/org/bukkit/plugin/package-info.java
index 087a0a4a..76fbe6ba 100644
--- a/src/main/javadoc/org/bukkit/plugin/package-info.java
+++ b/src/main/javadoc/org/bukkit/plugin/package-info.java
@@ -1,6 +1,5 @@
 /**
  * Classes specifically relating to loading software modules at runtime.
- * 
      
  */
 package org.bukkit.plugin;
 
diff --git a/src/main/javadoc/org/bukkit/potion/package-info.java b/src/main/javadoc/org/bukkit/potion/package-info.java
index 9b13a773..6dd34544 100644
--- a/src/main/javadoc/org/bukkit/potion/package-info.java
+++ b/src/main/javadoc/org/bukkit/potion/package-info.java
@@ -1,7 +1,6 @@
 /**
  * Classes to represent various {@link org.bukkit.Material#POTION potion}
  * properties and manipulation.
- * 
      
  */
 package org.bukkit.potion;
 
diff --git a/src/main/javadoc/org/bukkit/projectiles/package-info.java b/src/main/javadoc/org/bukkit/projectiles/package-info.java
index 0e396627..5efe7364 100644
--- a/src/main/javadoc/org/bukkit/projectiles/package-info.java
+++ b/src/main/javadoc/org/bukkit/projectiles/package-info.java
@@ -1,6 +1,5 @@
 /**
  * Classes to represent the source of a projectile
- * 
      
  */
 package org.bukkit.projectiles;
 
diff --git a/src/main/javadoc/org/bukkit/scheduler/package-info.java b/src/main/javadoc/org/bukkit/scheduler/package-info.java
index 87059ea1..c441df67 100644
--- a/src/main/javadoc/org/bukkit/scheduler/package-info.java
+++ b/src/main/javadoc/org/bukkit/scheduler/package-info.java
@@ -1,7 +1,6 @@
 /**
  * Classes dedicated to letting {@link org.bukkit.plugin.Plugin plugins} run
  * code at specific time intervals, including thread safety.
- * 
      
  */
 package org.bukkit.scheduler;
 
diff --git a/src/main/javadoc/org/bukkit/scoreboard/package-info.java b/src/main/javadoc/org/bukkit/scoreboard/package-info.java
index aad5e310..4d0b7e20 100644
--- a/src/main/javadoc/org/bukkit/scoreboard/package-info.java
+++ b/src/main/javadoc/org/bukkit/scoreboard/package-info.java
@@ -1,6 +1,5 @@
 /**
  * Interfaces used to manage the client side score display system.
- * 
      
  */
 package org.bukkit.scoreboard;
 
diff --git a/src/main/javadoc/org/bukkit/util/io/package-info.java b/src/main/javadoc/org/bukkit/util/io/package-info.java
index 8e46cca4..c4efffbd 100644
--- a/src/main/javadoc/org/bukkit/util/io/package-info.java
+++ b/src/main/javadoc/org/bukkit/util/io/package-info.java
@@ -1,6 +1,5 @@
 /**
  * Classes used to facilitate stream processing for specific Bukkit concepts.
- * 
      
  */
 package org.bukkit.util.io;
 
diff --git a/src/main/javadoc/org/bukkit/util/noise/package-info.java b/src/main/javadoc/org/bukkit/util/noise/package-info.java
index f77e35d0..8dd1501c 100644
--- a/src/main/javadoc/org/bukkit/util/noise/package-info.java
+++ b/src/main/javadoc/org/bukkit/util/noise/package-info.java
@@ -1,6 +1,5 @@
 /**
  * Classes dedicated to facilitating deterministic noise.
- * 
      
  */
 package org.bukkit.util.noise;
 
diff --git a/src/main/javadoc/org/bukkit/util/package-info.java b/src/main/javadoc/org/bukkit/util/package-info.java
index a9c4c9d8..58176d08 100644
--- a/src/main/javadoc/org/bukkit/util/package-info.java
+++ b/src/main/javadoc/org/bukkit/util/package-info.java
@@ -1,7 +1,6 @@
 /**
  * Multi and single purpose classes to facilitate various programmatic
  * concepts.
- * 
      
  */
 package org.bukkit.util;
 
diff --git a/src/main/javadoc/org/bukkit/util/permissions/package-info.java b/src/main/javadoc/org/bukkit/util/permissions/package-info.java
index 9a40b299..07498118 100644
--- a/src/main/javadoc/org/bukkit/util/permissions/package-info.java
+++ b/src/main/javadoc/org/bukkit/util/permissions/package-info.java
@@ -1,7 +1,6 @@
 /**
  * Static methods for miscellaneous {@link org.bukkit.permissions.Permission
  * permission} functionality.
- * 
      
  */
 package org.bukkit.util.permissions;
 
-- 
cgit v1.2.3


    The permission section's description
    NodeDescription