From abf0cfdcb4923fc5656f5d6925fd1571539c2de3 Mon Sep 17 00:00:00 2001 From: md_5 Date: Sun, 22 Dec 2019 09:56:28 +1100 Subject: [PATCH] Javadoc improvements per checkstyle --- checkstyle.xml | 13 +++++++++++++ src/main/java/org/bukkit/Color.java | 2 ++ src/main/java/org/bukkit/FireworkEffect.java | 4 +--- src/main/java/org/bukkit/GameRule.java | 2 ++ src/main/java/org/bukkit/Location.java | 12 ++++++------ .../java/org/bukkit/advancement/package-info.java | 4 ++++ .../java/org/bukkit/attribute/package-info.java | 4 ++++ src/main/java/org/bukkit/block/Campfire.java | 9 +++------ src/main/java/org/bukkit/block/CreatureSpawner.java | 6 +++--- .../java/org/bukkit/block/banner/package-info.java | 4 ++++ .../java/org/bukkit/block/data/package-info.java | 4 ++++ .../org/bukkit/block/data/type/package-info.java | 4 ++++ .../org/bukkit/block/package-info.java | 0 .../org/bukkit/block/structure/package-info.java | 4 ++++ src/main/java/org/bukkit/boss/package-info.java | 5 +++++ .../org/bukkit/command/defaults/package-info.java | 0 .../org/bukkit/command/package-info.java | 0 .../org/bukkit/configuration/file/package-info.java | 6 ++++++ .../org/bukkit/configuration/package-info.java | 0 .../configuration/serialization/package-info.java | 0 .../org/bukkit/conversations/package-info.java | 0 .../org/bukkit/enchantments/package-info.java | 0 src/main/java/org/bukkit/entity/EntityType.java | 4 ++++ .../java/org/bukkit/entity/memory/package-info.java | 6 ++++++ .../org/bukkit/entity/minecart/package-info.java | 0 .../org/bukkit/entity/package-info.java | 0 .../org/bukkit/event/block/BlockCanBuildEvent.java | 1 - .../org/bukkit/event/block/package-info.java | 0 .../org/bukkit/event/enchantment/package-info.java | 0 .../org/bukkit/event/entity/EntityDamageEvent.java | 2 +- .../event/entity/VillagerReplenishTradeEvent.java | 2 +- .../org/bukkit/event/entity/package-info.java | 0 .../org/bukkit/event/hanging/package-info.java | 0 .../event/inventory/InventoryInteractEvent.java | 2 +- .../org/bukkit/event/inventory/package-info.java | 0 .../org/bukkit/event/package-info.java | 0 .../bukkit/event/player/AsyncPlayerChatEvent.java | 1 - .../org/bukkit/event/player/package-info.java | 0 .../java/org/bukkit/event/raid/package-info.java | 4 ++++ .../org/bukkit/event/server/package-info.java | 0 .../org/bukkit/event/vehicle/package-info.java | 0 .../org/bukkit/event/weather/package-info.java | 0 .../org/bukkit/event/world/package-info.java | 0 .../org/bukkit/generator/package-info.java | 0 .../org/bukkit/help/package-info.java | 0 .../java/org/bukkit/inventory/InventoryView.java | 5 +++-- .../java/org/bukkit/inventory/meta/ItemMeta.java | 6 +++--- .../org/bukkit/inventory/meta/package-info.java | 0 .../bukkit/inventory/meta/tags/package-info.java | 4 ++++ .../org/bukkit/inventory/package-info.java | 0 src/main/java/org/bukkit/loot/package-info.java | 4 ++++ src/main/java/org/bukkit/map/MapCursor.java | 2 ++ .../org/bukkit/map/package-info.java | 0 src/main/java/org/bukkit/material/Banner.java | 1 - src/main/java/org/bukkit/material/Cauldron.java | 2 -- .../java/org/bukkit/material/ExtendedRails.java | 1 + src/main/java/org/bukkit/material/Step.java | 3 ++- .../org/bukkit/material/package-info.java | 0 .../org/bukkit/material/types/package-info.java | 4 ++++ .../java/org/bukkit/metadata/MetadataStoreBase.java | 6 +++--- .../org/bukkit/metadata/package-info.java | 0 .../{javadoc => java}/org/bukkit/package-info.java | 0 .../org/bukkit/permissions/package-info.java | 0 .../java/org/bukkit/persistence/package-info.java | 4 ++++ .../org/bukkit/plugin/java/package-info.java | 0 .../org/bukkit/plugin/messaging/package-info.java | 0 .../org/bukkit/plugin/package-info.java | 0 src/main/java/org/bukkit/potion/Potion.java | 4 +++- src/main/java/org/bukkit/potion/PotionEffect.java | 2 +- .../org/bukkit/potion/package-info.java | 0 .../org/bukkit/projectiles/package-info.java | 0 .../org/bukkit/scheduler/package-info.java | 0 src/main/java/org/bukkit/scoreboard/Scoreboard.java | 1 + src/main/java/org/bukkit/scoreboard/Team.java | 2 +- .../org/bukkit/scoreboard/package-info.java | 0 .../org/bukkit/util/io/BukkitObjectInputStream.java | 4 +++- .../bukkit/util/io/BukkitObjectOutputStream.java | 4 +++- .../org/bukkit/util/io/package-info.java | 0 .../org/bukkit/util/noise/package-info.java | 0 .../org/bukkit/util/package-info.java | 0 .../org/bukkit/util/permissions/package-info.java | 0 .../org/bukkit/configuration/file/package-info.java | 7 ------- src/test/java/org/bukkit/AnnotationTest.java | 3 +++ .../org/bukkit/configuration/file/package-info.java | 4 ++++ .../java/org/bukkit/configuration/package-info.java | 4 ++++ .../java/org/bukkit/conversations/package-info.java | 4 ++++ .../java/org/bukkit/entity/memory/package-info.java | 4 ++++ src/test/java/org/bukkit/event/package-info.java | 4 ++++ .../java/org/bukkit/materials/package-info.java | 4 ++++ .../bukkit/metadata/MetadataValueAdapterTest.java | 7 ++++++- src/test/java/org/bukkit/metadata/package-info.java | 4 ++++ src/test/java/org/bukkit/package-info.java | 4 ++++ .../org/bukkit/plugin/messaging/package-info.java | 4 ++++ src/test/java/org/bukkit/plugin/package-info.java | 4 ++++ src/test/java/org/bukkit/util/io/package-info.java | 4 ++++ src/test/java/org/bukkit/util/package-info.java | 4 ++++ 96 files changed, 181 insertions(+), 48 deletions(-) create mode 100644 src/main/java/org/bukkit/advancement/package-info.java create mode 100644 src/main/java/org/bukkit/attribute/package-info.java create mode 100644 src/main/java/org/bukkit/block/banner/package-info.java create mode 100644 src/main/java/org/bukkit/block/data/package-info.java create mode 100644 src/main/java/org/bukkit/block/data/type/package-info.java rename src/main/{javadoc => java}/org/bukkit/block/package-info.java (100%) create mode 100644 src/main/java/org/bukkit/block/structure/package-info.java create mode 100644 src/main/java/org/bukkit/boss/package-info.java rename src/main/{javadoc => java}/org/bukkit/command/defaults/package-info.java (100%) rename src/main/{javadoc => java}/org/bukkit/command/package-info.java (100%) create mode 100644 src/main/java/org/bukkit/configuration/file/package-info.java rename src/main/{javadoc => java}/org/bukkit/configuration/package-info.java (100%) rename src/main/{javadoc => java}/org/bukkit/configuration/serialization/package-info.java (100%) rename src/main/{javadoc => java}/org/bukkit/conversations/package-info.java (100%) rename src/main/{javadoc => java}/org/bukkit/enchantments/package-info.java (100%) create mode 100644 src/main/java/org/bukkit/entity/memory/package-info.java rename src/main/{javadoc => java}/org/bukkit/entity/minecart/package-info.java (100%) rename src/main/{javadoc => java}/org/bukkit/entity/package-info.java (100%) rename src/main/{javadoc => java}/org/bukkit/event/block/package-info.java (100%) rename src/main/{javadoc => java}/org/bukkit/event/enchantment/package-info.java (100%) rename src/main/{javadoc => java}/org/bukkit/event/entity/package-info.java (100%) rename src/main/{javadoc => java}/org/bukkit/event/hanging/package-info.java (100%) rename src/main/{javadoc => java}/org/bukkit/event/inventory/package-info.java (100%) rename src/main/{javadoc => java}/org/bukkit/event/package-info.java (100%) rename src/main/{javadoc => java}/org/bukkit/event/player/package-info.java (100%) create mode 100644 src/main/java/org/bukkit/event/raid/package-info.java rename src/main/{javadoc => java}/org/bukkit/event/server/package-info.java (100%) rename src/main/{javadoc => java}/org/bukkit/event/vehicle/package-info.java (100%) rename src/main/{javadoc => java}/org/bukkit/event/weather/package-info.java (100%) rename src/main/{javadoc => java}/org/bukkit/event/world/package-info.java (100%) rename src/main/{javadoc => java}/org/bukkit/generator/package-info.java (100%) rename src/main/{javadoc => java}/org/bukkit/help/package-info.java (100%) rename src/main/{javadoc => java}/org/bukkit/inventory/meta/package-info.java (100%) create mode 100644 src/main/java/org/bukkit/inventory/meta/tags/package-info.java rename src/main/{javadoc => java}/org/bukkit/inventory/package-info.java (100%) create mode 100644 src/main/java/org/bukkit/loot/package-info.java rename src/main/{javadoc => java}/org/bukkit/map/package-info.java (100%) rename src/main/{javadoc => java}/org/bukkit/material/package-info.java (100%) create mode 100644 src/main/java/org/bukkit/material/types/package-info.java rename src/main/{javadoc => java}/org/bukkit/metadata/package-info.java (100%) rename src/main/{javadoc => java}/org/bukkit/package-info.java (100%) rename src/main/{javadoc => java}/org/bukkit/permissions/package-info.java (100%) create mode 100644 src/main/java/org/bukkit/persistence/package-info.java rename src/main/{javadoc => java}/org/bukkit/plugin/java/package-info.java (100%) rename src/main/{javadoc => java}/org/bukkit/plugin/messaging/package-info.java (100%) rename src/main/{javadoc => java}/org/bukkit/plugin/package-info.java (100%) rename src/main/{javadoc => java}/org/bukkit/potion/package-info.java (100%) rename src/main/{javadoc => java}/org/bukkit/projectiles/package-info.java (100%) rename src/main/{javadoc => java}/org/bukkit/scheduler/package-info.java (100%) rename src/main/{javadoc => java}/org/bukkit/scoreboard/package-info.java (100%) rename src/main/{javadoc => java}/org/bukkit/util/io/package-info.java (100%) rename src/main/{javadoc => java}/org/bukkit/util/noise/package-info.java (100%) rename src/main/{javadoc => java}/org/bukkit/util/package-info.java (100%) rename src/main/{javadoc => java}/org/bukkit/util/permissions/package-info.java (100%) delete mode 100644 src/main/javadoc/org/bukkit/configuration/file/package-info.java create mode 100644 src/test/java/org/bukkit/configuration/file/package-info.java create mode 100644 src/test/java/org/bukkit/configuration/package-info.java create mode 100644 src/test/java/org/bukkit/conversations/package-info.java create mode 100644 src/test/java/org/bukkit/entity/memory/package-info.java create mode 100644 src/test/java/org/bukkit/event/package-info.java create mode 100644 src/test/java/org/bukkit/materials/package-info.java create mode 100644 src/test/java/org/bukkit/metadata/package-info.java create mode 100644 src/test/java/org/bukkit/package-info.java create mode 100644 src/test/java/org/bukkit/plugin/messaging/package-info.java create mode 100644 src/test/java/org/bukkit/plugin/package-info.java create mode 100644 src/test/java/org/bukkit/util/io/package-info.java create mode 100644 src/test/java/org/bukkit/util/package-info.java diff --git a/checkstyle.xml b/checkstyle.xml index e79a694b..80f4be49 100644 --- a/checkstyle.xml +++ b/checkstyle.xml @@ -20,7 +20,20 @@ + + + + + + + + + + + + + diff --git a/src/main/java/org/bukkit/Color.java b/src/main/java/org/bukkit/Color.java index 78be0f3b..deae003b 100644 --- a/src/main/java/org/bukkit/Color.java +++ b/src/main/java/org/bukkit/Color.java @@ -234,6 +234,7 @@ public final class Color implements ConfigurationSerializable { } /** + * Gets the color as an RGB integer. * * @return An integer representation of this color, as 0xRRGGBB */ @@ -242,6 +243,7 @@ public final class Color implements ConfigurationSerializable { } /** + * Gets the color as an BGR integer. * * @return An integer representation of this color, as 0xBBGGRR */ diff --git a/src/main/java/org/bukkit/FireworkEffect.java b/src/main/java/org/bukkit/FireworkEffect.java index 31e14b0c..0ae437c0 100644 --- a/src/main/java/org/bukkit/FireworkEffect.java +++ b/src/main/java/org/bukkit/FireworkEffect.java @@ -405,9 +405,7 @@ public final class FireworkEffect implements ConfigurationSerializable { @Override public int hashCode() { - /** - * TRUE and FALSE as per boolean.hashCode() - */ + // TRUE and FALSE as per boolean.hashCode() final int PRIME = 31, TRUE = 1231, FALSE = 1237; int hash = 1; hash = hash * PRIME + (flicker ? TRUE : FALSE); diff --git a/src/main/java/org/bukkit/GameRule.java b/src/main/java/org/bukkit/GameRule.java index a7020d5c..81a9630e 100644 --- a/src/main/java/org/bukkit/GameRule.java +++ b/src/main/java/org/bukkit/GameRule.java @@ -12,6 +12,8 @@ import org.jetbrains.annotations.Nullable; * For more information please visit the * Minecraft * Wiki + * + * @param type of rule (Boolean or Integer) */ public final class GameRule { diff --git a/src/main/java/org/bukkit/Location.java b/src/main/java/org/bukkit/Location.java index 44e3bca6..0939a807 100644 --- a/src/main/java/org/bukkit/Location.java +++ b/src/main/java/org/bukkit/Location.java @@ -449,8 +449,8 @@ public class Location implements Cloneable, ConfigurationSerializable { * function overflows, which will be caused if the length is too long. Not * world-aware and orientation independent. * - * @see Vector * @return the magnitude + * @see Vector */ public double length() { return Math.sqrt(NumberConversions.square(x) + NumberConversions.square(y) + NumberConversions.square(z)); @@ -460,8 +460,8 @@ public class Location implements Cloneable, ConfigurationSerializable { * Gets the magnitude of the location squared. Not world-aware and * orientation independent. * - * @see Vector * @return the magnitude + * @see Vector */ public double lengthSquared() { return NumberConversions.square(x) + NumberConversions.square(y) + NumberConversions.square(z); @@ -474,10 +474,10 @@ public class Location implements Cloneable, ConfigurationSerializable { * be returned if the inner result of the sqrt() function overflows, which * will be caused if the distance is too long. * - * @see Vector * @param o The other location * @return the distance * @throws IllegalArgumentException for differing worlds + * @see Vector */ public double distance(@NotNull Location o) { return Math.sqrt(distanceSquared(o)); @@ -486,10 +486,10 @@ public class Location implements Cloneable, ConfigurationSerializable { /** * Get the squared distance between this location and another. * - * @see Vector * @param o The other location * @return the distance * @throws IllegalArgumentException for differing worlds + * @see Vector */ public double distanceSquared(@NotNull Location o) { if (o == null) { @@ -508,8 +508,8 @@ public class Location implements Cloneable, ConfigurationSerializable { * scalar. Not world-aware. * * @param m The factor - * @see Vector * @return the same location + * @see Vector */ @NotNull public Location multiply(double m) { @@ -522,8 +522,8 @@ public class Location implements Cloneable, ConfigurationSerializable { /** * Zero this location's components. Not world-aware. * - * @see Vector * @return the same location + * @see Vector */ @NotNull public Location zero() { diff --git a/src/main/java/org/bukkit/advancement/package-info.java b/src/main/java/org/bukkit/advancement/package-info.java new file mode 100644 index 00000000..665b0a29 --- /dev/null +++ b/src/main/java/org/bukkit/advancement/package-info.java @@ -0,0 +1,4 @@ +/** + * Classes relevant to advancements. + */ +package org.bukkit.advancement; diff --git a/src/main/java/org/bukkit/attribute/package-info.java b/src/main/java/org/bukkit/attribute/package-info.java new file mode 100644 index 00000000..125adf41 --- /dev/null +++ b/src/main/java/org/bukkit/attribute/package-info.java @@ -0,0 +1,4 @@ +/** + * Classes relevant to attributes. + */ +package org.bukkit.attribute; diff --git a/src/main/java/org/bukkit/block/Campfire.java b/src/main/java/org/bukkit/block/Campfire.java index 09522d5e..f8a344ca 100644 --- a/src/main/java/org/bukkit/block/Campfire.java +++ b/src/main/java/org/bukkit/block/Campfire.java @@ -10,26 +10,23 @@ import org.jetbrains.annotations.Nullable; public interface Campfire extends TileState { /** - * @see Inventory#getSize() - * * @return The size of the inventory + * @see Inventory#getSize() */ int getSize(); /** - * @see Inventory#getItem(int) - * * @param index The index of the Slot's ItemStack to return * @return The ItemStack in the slot + * @see Inventory#getItem(int) */ @Nullable ItemStack getItem(int index); /** - * @see Inventory#setItem(int, org.bukkit.inventory.ItemStack) - * * @param index The index where to put the ItemStack * @param item The ItemStack to set + * @see Inventory#setItem(int, org.bukkit.inventory.ItemStack) */ void setItem(int index, @Nullable ItemStack item); diff --git a/src/main/java/org/bukkit/block/CreatureSpawner.java b/src/main/java/org/bukkit/block/CreatureSpawner.java index e73fb0ef..cb447a4a 100644 --- a/src/main/java/org/bukkit/block/CreatureSpawner.java +++ b/src/main/java/org/bukkit/block/CreatureSpawner.java @@ -78,8 +78,8 @@ public interface CreatureSpawner extends TileState { /** * Set the minimum spawn delay amount (in ticks). * - * @see #getMinSpawnDelay() * @param delay the minimum spawn delay amount + * @see #getMinSpawnDelay() */ public void setMinSpawnDelay(int delay); @@ -105,8 +105,8 @@ public interface CreatureSpawner extends TileState { * This value must be greater than 0, as well as greater than or * equal to {@link #getMinSpawnDelay()} * - * @see #getMaxSpawnDelay() * @param delay the new maximum spawn delay amount + * @see #getMaxSpawnDelay() */ public void setMaxSpawnDelay(int delay); @@ -195,8 +195,8 @@ public interface CreatureSpawner extends TileState { * Set the new spawn range. *
* - * @see #getSpawnRange() * @param spawnRange the new spawn range + * @see #getSpawnRange() */ public void setSpawnRange(int spawnRange); } diff --git a/src/main/java/org/bukkit/block/banner/package-info.java b/src/main/java/org/bukkit/block/banner/package-info.java new file mode 100644 index 00000000..7aab22b9 --- /dev/null +++ b/src/main/java/org/bukkit/block/banner/package-info.java @@ -0,0 +1,4 @@ +/** + * Classes relevant to banner blocks. + */ +package org.bukkit.block.banner; diff --git a/src/main/java/org/bukkit/block/data/package-info.java b/src/main/java/org/bukkit/block/data/package-info.java new file mode 100644 index 00000000..1b6b4874 --- /dev/null +++ b/src/main/java/org/bukkit/block/data/package-info.java @@ -0,0 +1,4 @@ +/** + * Generalized BlockData classes. + */ +package org.bukkit.block.data; diff --git a/src/main/java/org/bukkit/block/data/type/package-info.java b/src/main/java/org/bukkit/block/data/type/package-info.java new file mode 100644 index 00000000..f613bbb4 --- /dev/null +++ b/src/main/java/org/bukkit/block/data/type/package-info.java @@ -0,0 +1,4 @@ +/** + * Specific BlockData classes relevant to only a given block or set of blocks. + */ +package org.bukkit.block.data.type; diff --git a/src/main/javadoc/org/bukkit/block/package-info.java b/src/main/java/org/bukkit/block/package-info.java similarity index 100% rename from src/main/javadoc/org/bukkit/block/package-info.java rename to src/main/java/org/bukkit/block/package-info.java diff --git a/src/main/java/org/bukkit/block/structure/package-info.java b/src/main/java/org/bukkit/block/structure/package-info.java new file mode 100644 index 00000000..33715265 --- /dev/null +++ b/src/main/java/org/bukkit/block/structure/package-info.java @@ -0,0 +1,4 @@ +/** + * Classes relevant to structure blocks. + */ +package org.bukkit.block.structure; diff --git a/src/main/java/org/bukkit/boss/package-info.java b/src/main/java/org/bukkit/boss/package-info.java new file mode 100644 index 00000000..07a7e213 --- /dev/null +++ b/src/main/java/org/bukkit/boss/package-info.java @@ -0,0 +1,5 @@ +/** + * Classes concerning the creation of boss bars that appear at the top of the + * player's screen. + */ +package org.bukkit.boss; diff --git a/src/main/javadoc/org/bukkit/command/defaults/package-info.java b/src/main/java/org/bukkit/command/defaults/package-info.java similarity index 100% rename from src/main/javadoc/org/bukkit/command/defaults/package-info.java rename to src/main/java/org/bukkit/command/defaults/package-info.java diff --git a/src/main/javadoc/org/bukkit/command/package-info.java b/src/main/java/org/bukkit/command/package-info.java similarity index 100% rename from src/main/javadoc/org/bukkit/command/package-info.java rename to src/main/java/org/bukkit/command/package-info.java diff --git a/src/main/java/org/bukkit/configuration/file/package-info.java b/src/main/java/org/bukkit/configuration/file/package-info.java new file mode 100644 index 00000000..bbe750de --- /dev/null +++ b/src/main/java/org/bukkit/configuration/file/package-info.java @@ -0,0 +1,6 @@ +/** + * Classes dedicated to 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/java/org/bukkit/configuration/package-info.java similarity index 100% rename from src/main/javadoc/org/bukkit/configuration/package-info.java rename to src/main/java/org/bukkit/configuration/package-info.java diff --git a/src/main/javadoc/org/bukkit/configuration/serialization/package-info.java b/src/main/java/org/bukkit/configuration/serialization/package-info.java similarity index 100% rename from src/main/javadoc/org/bukkit/configuration/serialization/package-info.java rename to src/main/java/org/bukkit/configuration/serialization/package-info.java diff --git a/src/main/javadoc/org/bukkit/conversations/package-info.java b/src/main/java/org/bukkit/conversations/package-info.java similarity index 100% rename from src/main/javadoc/org/bukkit/conversations/package-info.java rename to src/main/java/org/bukkit/conversations/package-info.java diff --git a/src/main/javadoc/org/bukkit/enchantments/package-info.java b/src/main/java/org/bukkit/enchantments/package-info.java similarity index 100% rename from src/main/javadoc/org/bukkit/enchantments/package-info.java rename to src/main/java/org/bukkit/enchantments/package-info.java diff --git a/src/main/java/org/bukkit/entity/EntityType.java b/src/main/java/org/bukkit/entity/EntityType.java index 0ab001b7..ad12496e 100644 --- a/src/main/java/org/bukkit/entity/EntityType.java +++ b/src/main/java/org/bukkit/entity/EntityType.java @@ -325,6 +325,7 @@ public enum EntityType implements Keyed { } /** + * Gets the entity type name. * * @return the entity type's name * @deprecated Magic value @@ -349,6 +350,7 @@ public enum EntityType implements Keyed { } /** + * Gets the entity type id. * * @return the raw type id * @deprecated Magic value @@ -359,6 +361,7 @@ public enum EntityType implements Keyed { } /** + * Gets an entity type from its name. * * @param name the entity type's name * @return the matching entity type or null @@ -375,6 +378,7 @@ public enum EntityType implements Keyed { } /** + * Gets an entity from its id. * * @param id the raw type id * @return the matching entity type or null diff --git a/src/main/java/org/bukkit/entity/memory/package-info.java b/src/main/java/org/bukkit/entity/memory/package-info.java new file mode 100644 index 00000000..58887a4d --- /dev/null +++ b/src/main/java/org/bukkit/entity/memory/package-info.java @@ -0,0 +1,6 @@ +/** + * Classes concerning an entity's persistent memory. + * + * Currently only relevant for Villagers. + */ +package org.bukkit.entity.memory; diff --git a/src/main/javadoc/org/bukkit/entity/minecart/package-info.java b/src/main/java/org/bukkit/entity/minecart/package-info.java similarity index 100% rename from src/main/javadoc/org/bukkit/entity/minecart/package-info.java rename to src/main/java/org/bukkit/entity/minecart/package-info.java diff --git a/src/main/javadoc/org/bukkit/entity/package-info.java b/src/main/java/org/bukkit/entity/package-info.java similarity index 100% rename from src/main/javadoc/org/bukkit/entity/package-info.java rename to src/main/java/org/bukkit/entity/package-info.java diff --git a/src/main/java/org/bukkit/event/block/BlockCanBuildEvent.java b/src/main/java/org/bukkit/event/block/BlockCanBuildEvent.java index 977eb8d3..a1350c0f 100644 --- a/src/main/java/org/bukkit/event/block/BlockCanBuildEvent.java +++ b/src/main/java/org/bukkit/event/block/BlockCanBuildEvent.java @@ -32,7 +32,6 @@ public class BlockCanBuildEvent extends BlockEvent { } /** - * * @param block the block involved in this event * @param player the player placing the block * @param type the id of the block to place diff --git a/src/main/javadoc/org/bukkit/event/block/package-info.java b/src/main/java/org/bukkit/event/block/package-info.java similarity index 100% rename from src/main/javadoc/org/bukkit/event/block/package-info.java rename to src/main/java/org/bukkit/event/block/package-info.java diff --git a/src/main/javadoc/org/bukkit/event/enchantment/package-info.java b/src/main/java/org/bukkit/event/enchantment/package-info.java similarity index 100% rename from src/main/javadoc/org/bukkit/event/enchantment/package-info.java rename to src/main/java/org/bukkit/event/enchantment/package-info.java diff --git a/src/main/java/org/bukkit/event/entity/EntityDamageEvent.java b/src/main/java/org/bukkit/event/entity/EntityDamageEvent.java index 4d1b4d1f..feec8b1e 100644 --- a/src/main/java/org/bukkit/event/entity/EntityDamageEvent.java +++ b/src/main/java/org/bukkit/event/entity/EntityDamageEvent.java @@ -77,11 +77,11 @@ public class EntityDamageEvent extends EntityEvent implements Cancellable { * * @param type the damage modifier * @param damage the scalar value of the damage's modifier - * @see #getFinalDamage() * @throws IllegalArgumentException if type is null * @throws UnsupportedOperationException if the caller does not support * the particular DamageModifier, or to rephrase, when {@link * #isApplicable(DamageModifier)} returns false + * @see #getFinalDamage() */ public void setDamage(@NotNull DamageModifier type, double damage) throws IllegalArgumentException, UnsupportedOperationException { if (!modifiers.containsKey(type)) { diff --git a/src/main/java/org/bukkit/event/entity/VillagerReplenishTradeEvent.java b/src/main/java/org/bukkit/event/entity/VillagerReplenishTradeEvent.java index ff5f484c..36bfe05f 100644 --- a/src/main/java/org/bukkit/event/entity/VillagerReplenishTradeEvent.java +++ b/src/main/java/org/bukkit/event/entity/VillagerReplenishTradeEvent.java @@ -58,8 +58,8 @@ public class VillagerReplenishTradeEvent extends EntityEvent implements Cancella /** * Set the bonus uses added. * - * @see VillagerReplenishTradeEvent#getBonus() * @param bonus the extra uses added + * @see VillagerReplenishTradeEvent#getBonus() */ public void setBonus(int bonus) { this.bonus = bonus; diff --git a/src/main/javadoc/org/bukkit/event/entity/package-info.java b/src/main/java/org/bukkit/event/entity/package-info.java similarity index 100% rename from src/main/javadoc/org/bukkit/event/entity/package-info.java rename to src/main/java/org/bukkit/event/entity/package-info.java diff --git a/src/main/javadoc/org/bukkit/event/hanging/package-info.java b/src/main/java/org/bukkit/event/hanging/package-info.java similarity index 100% rename from src/main/javadoc/org/bukkit/event/hanging/package-info.java rename to src/main/java/org/bukkit/event/hanging/package-info.java diff --git a/src/main/java/org/bukkit/event/inventory/InventoryInteractEvent.java b/src/main/java/org/bukkit/event/inventory/InventoryInteractEvent.java index 707b4381..14f821ca 100644 --- a/src/main/java/org/bukkit/event/inventory/InventoryInteractEvent.java +++ b/src/main/java/org/bukkit/event/inventory/InventoryInteractEvent.java @@ -30,8 +30,8 @@ public abstract class InventoryInteractEvent extends InventoryEvent implements C * Sets the result of this event. This will change whether or not this * event is considered cancelled. * - * @see #isCancelled() * @param newResult the new {@link org.bukkit.event.Event.Result} for this event + * @see #isCancelled() */ public void setResult(@NotNull Result newResult) { result = newResult; diff --git a/src/main/javadoc/org/bukkit/event/inventory/package-info.java b/src/main/java/org/bukkit/event/inventory/package-info.java similarity index 100% rename from src/main/javadoc/org/bukkit/event/inventory/package-info.java rename to src/main/java/org/bukkit/event/inventory/package-info.java diff --git a/src/main/javadoc/org/bukkit/event/package-info.java b/src/main/java/org/bukkit/event/package-info.java similarity index 100% rename from src/main/javadoc/org/bukkit/event/package-info.java rename to src/main/java/org/bukkit/event/package-info.java diff --git a/src/main/java/org/bukkit/event/player/AsyncPlayerChatEvent.java b/src/main/java/org/bukkit/event/player/AsyncPlayerChatEvent.java index ab129b05..9c68c3f2 100644 --- a/src/main/java/org/bukkit/event/player/AsyncPlayerChatEvent.java +++ b/src/main/java/org/bukkit/event/player/AsyncPlayerChatEvent.java @@ -31,7 +31,6 @@ public class AsyncPlayerChatEvent extends PlayerEvent implements Cancellable { private final Set recipients; /** - * * @param async This changes the event to a synchronous state. * @param who the chat sender * @param message the message sent diff --git a/src/main/javadoc/org/bukkit/event/player/package-info.java b/src/main/java/org/bukkit/event/player/package-info.java similarity index 100% rename from src/main/javadoc/org/bukkit/event/player/package-info.java rename to src/main/java/org/bukkit/event/player/package-info.java diff --git a/src/main/java/org/bukkit/event/raid/package-info.java b/src/main/java/org/bukkit/event/raid/package-info.java new file mode 100644 index 00000000..a1c49035 --- /dev/null +++ b/src/main/java/org/bukkit/event/raid/package-info.java @@ -0,0 +1,4 @@ +/** + * Events related to raids. + */ +package org.bukkit.event.raid; diff --git a/src/main/javadoc/org/bukkit/event/server/package-info.java b/src/main/java/org/bukkit/event/server/package-info.java similarity index 100% rename from src/main/javadoc/org/bukkit/event/server/package-info.java rename to src/main/java/org/bukkit/event/server/package-info.java diff --git a/src/main/javadoc/org/bukkit/event/vehicle/package-info.java b/src/main/java/org/bukkit/event/vehicle/package-info.java similarity index 100% rename from src/main/javadoc/org/bukkit/event/vehicle/package-info.java rename to src/main/java/org/bukkit/event/vehicle/package-info.java diff --git a/src/main/javadoc/org/bukkit/event/weather/package-info.java b/src/main/java/org/bukkit/event/weather/package-info.java similarity index 100% rename from src/main/javadoc/org/bukkit/event/weather/package-info.java rename to src/main/java/org/bukkit/event/weather/package-info.java diff --git a/src/main/javadoc/org/bukkit/event/world/package-info.java b/src/main/java/org/bukkit/event/world/package-info.java similarity index 100% rename from src/main/javadoc/org/bukkit/event/world/package-info.java rename to src/main/java/org/bukkit/event/world/package-info.java diff --git a/src/main/javadoc/org/bukkit/generator/package-info.java b/src/main/java/org/bukkit/generator/package-info.java similarity index 100% rename from src/main/javadoc/org/bukkit/generator/package-info.java rename to src/main/java/org/bukkit/generator/package-info.java diff --git a/src/main/javadoc/org/bukkit/help/package-info.java b/src/main/java/org/bukkit/help/package-info.java similarity index 100% rename from src/main/javadoc/org/bukkit/help/package-info.java rename to src/main/java/org/bukkit/help/package-info.java diff --git a/src/main/java/org/bukkit/inventory/InventoryView.java b/src/main/java/org/bukkit/inventory/InventoryView.java index 62d79142..d4a15397 100644 --- a/src/main/java/org/bukkit/inventory/InventoryView.java +++ b/src/main/java/org/bukkit/inventory/InventoryView.java @@ -116,6 +116,7 @@ public abstract class InventoryView { } /** + * Gets the id of this view. * * @return the id of this view * @deprecated Magic value @@ -264,7 +265,7 @@ public abstract class InventoryView { // Player crafting slots are indexed differently. The matrix is caught by the first return. // Creative mode is the same, except that you can't see the crafting slots (but the IDs are still used) if (getType() == InventoryType.CRAFTING || getType() == InventoryType.CREATIVE) { - /** + /* * Raw Slots: * * 5 1 2 0 @@ -277,7 +278,7 @@ public abstract class InventoryView { * 36 37 38 39 40 41 42 43 44 */ - /** + /* * Converted Slots: * * 39 1 2 0 diff --git a/src/main/java/org/bukkit/inventory/meta/ItemMeta.java b/src/main/java/org/bukkit/inventory/meta/ItemMeta.java index 1df31be7..f2e9f275 100644 --- a/src/main/java/org/bukkit/inventory/meta/ItemMeta.java +++ b/src/main/java/org/bukkit/inventory/meta/ItemMeta.java @@ -351,10 +351,10 @@ public interface ItemMeta extends Cloneable, ConfigurationSerializable, Persiste * @param modifier the {@link AttributeModifier} to remove * @return if any attribute modifiers were remove * - * @see AttributeModifier#getUniqueId() - * * @throws NullPointerException if the Attribute is null * @throws NullPointerException if the AttributeModifier is null + * + * @see AttributeModifier#getUniqueId() */ boolean removeAttributeModifier(@NotNull Attribute attribute, @NotNull AttributeModifier modifier); @@ -380,7 +380,7 @@ public interface ItemMeta extends Cloneable, ConfigurationSerializable, Persiste * Internal use only! Do not use under any circumstances! * * @param version version - * @deprecated + * @deprecated internal use only */ @Deprecated void setVersion(int version); diff --git a/src/main/javadoc/org/bukkit/inventory/meta/package-info.java b/src/main/java/org/bukkit/inventory/meta/package-info.java similarity index 100% rename from src/main/javadoc/org/bukkit/inventory/meta/package-info.java rename to src/main/java/org/bukkit/inventory/meta/package-info.java diff --git a/src/main/java/org/bukkit/inventory/meta/tags/package-info.java b/src/main/java/org/bukkit/inventory/meta/tags/package-info.java new file mode 100644 index 00000000..f5a7bed6 --- /dev/null +++ b/src/main/java/org/bukkit/inventory/meta/tags/package-info.java @@ -0,0 +1,4 @@ +/** + * Classes that allow attaching custom data to items. + */ +package org.bukkit.inventory.meta.tags; diff --git a/src/main/javadoc/org/bukkit/inventory/package-info.java b/src/main/java/org/bukkit/inventory/package-info.java similarity index 100% rename from src/main/javadoc/org/bukkit/inventory/package-info.java rename to src/main/java/org/bukkit/inventory/package-info.java diff --git a/src/main/java/org/bukkit/loot/package-info.java b/src/main/java/org/bukkit/loot/package-info.java new file mode 100644 index 00000000..c346fb40 --- /dev/null +++ b/src/main/java/org/bukkit/loot/package-info.java @@ -0,0 +1,4 @@ +/** + * Classes relevant to loot table manipulation and generation. + */ +package org.bukkit.loot; diff --git a/src/main/java/org/bukkit/map/MapCursor.java b/src/main/java/org/bukkit/map/MapCursor.java index 29f97994..83354b2a 100644 --- a/src/main/java/org/bukkit/map/MapCursor.java +++ b/src/main/java/org/bukkit/map/MapCursor.java @@ -261,6 +261,7 @@ public final class MapCursor { } /** + * Gets the internal value of the cursor. * * @return the value * @deprecated Magic value @@ -271,6 +272,7 @@ public final class MapCursor { } /** + * Get a cursor by its internal value. * * @param value the value * @return the matching type diff --git a/src/main/javadoc/org/bukkit/map/package-info.java b/src/main/java/org/bukkit/map/package-info.java similarity index 100% rename from src/main/javadoc/org/bukkit/map/package-info.java rename to src/main/java/org/bukkit/map/package-info.java diff --git a/src/main/java/org/bukkit/material/Banner.java b/src/main/java/org/bukkit/material/Banner.java index 02d5fb67..08ce9d8b 100644 --- a/src/main/java/org/bukkit/material/Banner.java +++ b/src/main/java/org/bukkit/material/Banner.java @@ -19,7 +19,6 @@ public class Banner extends MaterialData implements Attachable { } /** - * * @param type the type * @param data the raw data value * @deprecated Magic value diff --git a/src/main/java/org/bukkit/material/Cauldron.java b/src/main/java/org/bukkit/material/Cauldron.java index f998396c..b331b4c2 100644 --- a/src/main/java/org/bukkit/material/Cauldron.java +++ b/src/main/java/org/bukkit/material/Cauldron.java @@ -18,7 +18,6 @@ public class Cauldron extends MaterialData { } /** - * * @param type the type * @param data the raw data value * @deprecated Magic value @@ -29,7 +28,6 @@ public class Cauldron extends MaterialData { } /** - * * @param data the raw data value * @deprecated Magic value */ diff --git a/src/main/java/org/bukkit/material/ExtendedRails.java b/src/main/java/org/bukkit/material/ExtendedRails.java index 5f70e5bd..9b2577f7 100644 --- a/src/main/java/org/bukkit/material/ExtendedRails.java +++ b/src/main/java/org/bukkit/material/ExtendedRails.java @@ -33,6 +33,7 @@ public class ExtendedRails extends Rails { } /** + * {@inheritDoc} * * @deprecated Magic value */ diff --git a/src/main/java/org/bukkit/material/Step.java b/src/main/java/org/bukkit/material/Step.java index 8b92ec4e..9f502e7e 100644 --- a/src/main/java/org/bukkit/material/Step.java +++ b/src/main/java/org/bukkit/material/Step.java @@ -74,16 +74,17 @@ public class Step extends TexturedMaterial { } /** + * {@inheritDoc} * * @deprecated Magic value */ - @Deprecated @Override protected int getTextureIndex() { return getData() & 0x7; } /** + * {@inheritDoc} * * @deprecated Magic value */ diff --git a/src/main/javadoc/org/bukkit/material/package-info.java b/src/main/java/org/bukkit/material/package-info.java similarity index 100% rename from src/main/javadoc/org/bukkit/material/package-info.java rename to src/main/java/org/bukkit/material/package-info.java diff --git a/src/main/java/org/bukkit/material/types/package-info.java b/src/main/java/org/bukkit/material/types/package-info.java new file mode 100644 index 00000000..da10d800 --- /dev/null +++ b/src/main/java/org/bukkit/material/types/package-info.java @@ -0,0 +1,4 @@ +/** + * Classes relevant to specific material types. + */ +package org.bukkit.material.types; diff --git a/src/main/java/org/bukkit/metadata/MetadataStoreBase.java b/src/main/java/org/bukkit/metadata/MetadataStoreBase.java index 02795349..baf85022 100644 --- a/src/main/java/org/bukkit/metadata/MetadataStoreBase.java +++ b/src/main/java/org/bukkit/metadata/MetadataStoreBase.java @@ -32,9 +32,9 @@ public abstract class MetadataStoreBase { * @param subject The object receiving the metadata. * @param metadataKey A unique key to identify this metadata. * @param newMetadataValue The metadata value to apply. - * @see MetadataStore#setMetadata(Object, String, MetadataValue) * @throws IllegalArgumentException If value is null, or the owning plugin * is null + * @see MetadataStore#setMetadata(Object, String, MetadataValue) */ public synchronized void setMetadata(@NotNull T subject, @NotNull String metadataKey, @NotNull MetadataValue newMetadataValue) { Validate.notNull(newMetadataValue, "Value cannot be null"); @@ -90,9 +90,9 @@ public abstract class MetadataStoreBase { * @param metadataKey the unique metadata key identifying the metadata to * remove. * @param owningPlugin the plugin attempting to remove a metadata item. + * @throws IllegalArgumentException If plugin is null * @see MetadataStore#removeMetadata(Object, String, * org.bukkit.plugin.Plugin) - * @throws IllegalArgumentException If plugin is null */ public synchronized void removeMetadata(@NotNull T subject, @NotNull String metadataKey, @NotNull Plugin owningPlugin) { Validate.notNull(owningPlugin, "Plugin cannot be null"); @@ -114,8 +114,8 @@ public abstract class MetadataStoreBase { * be recalculated the next time it is accessed. * * @param owningPlugin the plugin requesting the invalidation. - * @see MetadataStore#invalidateAll(org.bukkit.plugin.Plugin) * @throws IllegalArgumentException If plugin is null + * @see MetadataStore#invalidateAll(org.bukkit.plugin.Plugin) */ public synchronized void invalidateAll(@NotNull Plugin owningPlugin) { Validate.notNull(owningPlugin, "Plugin cannot be null"); diff --git a/src/main/javadoc/org/bukkit/metadata/package-info.java b/src/main/java/org/bukkit/metadata/package-info.java similarity index 100% rename from src/main/javadoc/org/bukkit/metadata/package-info.java rename to src/main/java/org/bukkit/metadata/package-info.java diff --git a/src/main/javadoc/org/bukkit/package-info.java b/src/main/java/org/bukkit/package-info.java similarity index 100% rename from src/main/javadoc/org/bukkit/package-info.java rename to src/main/java/org/bukkit/package-info.java diff --git a/src/main/javadoc/org/bukkit/permissions/package-info.java b/src/main/java/org/bukkit/permissions/package-info.java similarity index 100% rename from src/main/javadoc/org/bukkit/permissions/package-info.java rename to src/main/java/org/bukkit/permissions/package-info.java diff --git a/src/main/java/org/bukkit/persistence/package-info.java b/src/main/java/org/bukkit/persistence/package-info.java new file mode 100644 index 00000000..41f4628d --- /dev/null +++ b/src/main/java/org/bukkit/persistence/package-info.java @@ -0,0 +1,4 @@ +/** + * Classes that allow attaching persistent data to various objects. + */ +package org.bukkit.persistence; diff --git a/src/main/javadoc/org/bukkit/plugin/java/package-info.java b/src/main/java/org/bukkit/plugin/java/package-info.java similarity index 100% rename from src/main/javadoc/org/bukkit/plugin/java/package-info.java rename to src/main/java/org/bukkit/plugin/java/package-info.java diff --git a/src/main/javadoc/org/bukkit/plugin/messaging/package-info.java b/src/main/java/org/bukkit/plugin/messaging/package-info.java similarity index 100% rename from src/main/javadoc/org/bukkit/plugin/messaging/package-info.java rename to src/main/java/org/bukkit/plugin/messaging/package-info.java diff --git a/src/main/javadoc/org/bukkit/plugin/package-info.java b/src/main/java/org/bukkit/plugin/package-info.java similarity index 100% rename from src/main/javadoc/org/bukkit/plugin/package-info.java rename to src/main/java/org/bukkit/plugin/package-info.java diff --git a/src/main/java/org/bukkit/potion/Potion.java b/src/main/java/org/bukkit/potion/Potion.java index 3c400a04..b9dbbfd0 100644 --- a/src/main/java/org/bukkit/potion/Potion.java +++ b/src/main/java/org/bukkit/potion/Potion.java @@ -117,8 +117,8 @@ public class Potion { * Applies the effects that would be applied by this potion to the given * {@link LivingEntity}. * - * @see LivingEntity#addPotionEffects(Collection) * @param to The entity to apply the effects to + * @see LivingEntity#addPotionEffects(Collection) */ public void apply(@NotNull LivingEntity to) { Validate.notNull(to, "entity cannot be null"); @@ -281,6 +281,7 @@ public class Potion { private static final int TIER_SHIFT = 5; /** + * Gets the potion from its damage value. * * @param damage the damage value * @return the produced potion @@ -382,6 +383,7 @@ public class Potion { } /** + * Gets the potion from its name id. * * @return the name id * @deprecated Non-functional diff --git a/src/main/java/org/bukkit/potion/PotionEffect.java b/src/main/java/org/bukkit/potion/PotionEffect.java index bbefcd58..60716c62 100644 --- a/src/main/java/org/bukkit/potion/PotionEffect.java +++ b/src/main/java/org/bukkit/potion/PotionEffect.java @@ -144,9 +144,9 @@ public class PotionEffect implements ConfigurationSerializable { * Attempts to add the effect represented by this object to the given * {@link LivingEntity}. * - * @see LivingEntity#addPotionEffect(PotionEffect) * @param entity The entity to add this effect to * @return Whether the effect could be added + * @see LivingEntity#addPotionEffect(PotionEffect) */ public boolean apply(@NotNull LivingEntity entity) { return entity.addPotionEffect(this); diff --git a/src/main/javadoc/org/bukkit/potion/package-info.java b/src/main/java/org/bukkit/potion/package-info.java similarity index 100% rename from src/main/javadoc/org/bukkit/potion/package-info.java rename to src/main/java/org/bukkit/potion/package-info.java diff --git a/src/main/javadoc/org/bukkit/projectiles/package-info.java b/src/main/java/org/bukkit/projectiles/package-info.java similarity index 100% rename from src/main/javadoc/org/bukkit/projectiles/package-info.java rename to src/main/java/org/bukkit/projectiles/package-info.java diff --git a/src/main/javadoc/org/bukkit/scheduler/package-info.java b/src/main/java/org/bukkit/scheduler/package-info.java similarity index 100% rename from src/main/javadoc/org/bukkit/scheduler/package-info.java rename to src/main/java/org/bukkit/scheduler/package-info.java diff --git a/src/main/java/org/bukkit/scoreboard/Scoreboard.java b/src/main/java/org/bukkit/scoreboard/Scoreboard.java index aeab2425..4bfaaea7 100644 --- a/src/main/java/org/bukkit/scoreboard/Scoreboard.java +++ b/src/main/java/org/bukkit/scoreboard/Scoreboard.java @@ -85,6 +85,7 @@ public interface Scoreboard { * * @param criteria Criteria to search by * @return an immutable set of Objectives using the specified Criteria + * @throws IllegalArgumentException if criteria is null */ @NotNull Set getObjectivesByCriteria(@NotNull String criteria) throws IllegalArgumentException; diff --git a/src/main/java/org/bukkit/scoreboard/Team.java b/src/main/java/org/bukkit/scoreboard/Team.java index dc20daae..da01d292 100644 --- a/src/main/java/org/bukkit/scoreboard/Team.java +++ b/src/main/java/org/bukkit/scoreboard/Team.java @@ -241,9 +241,9 @@ public interface Team { * Removes the entry from this team. * * @param entry the entry to remove + * @return if the entry was a part of this team * @throws IllegalArgumentException if entry is null * @throws IllegalStateException if this team has been unregistered - * @return if the entry was a part of this team */ boolean removeEntry(@NotNull String entry) throws IllegalStateException, IllegalArgumentException; diff --git a/src/main/javadoc/org/bukkit/scoreboard/package-info.java b/src/main/java/org/bukkit/scoreboard/package-info.java similarity index 100% rename from src/main/javadoc/org/bukkit/scoreboard/package-info.java rename to src/main/java/org/bukkit/scoreboard/package-info.java diff --git a/src/main/java/org/bukkit/util/io/BukkitObjectInputStream.java b/src/main/java/org/bukkit/util/io/BukkitObjectInputStream.java index d05aaaa4..0f8eb97b 100644 --- a/src/main/java/org/bukkit/util/io/BukkitObjectInputStream.java +++ b/src/main/java/org/bukkit/util/io/BukkitObjectInputStream.java @@ -20,7 +20,9 @@ public class BukkitObjectInputStream extends ObjectInputStream { /** * Constructor provided to mirror super functionality. * - * @throws IOException if an I/O error occurs while reading stream heade + * @throws IOException if an I/O error occurs while creating this stream + * @throws SecurityException if a security manager exists and denies + * enabling subclassing * @see ObjectInputStream#ObjectInputStream() */ protected BukkitObjectInputStream() throws IOException, SecurityException { diff --git a/src/main/java/org/bukkit/util/io/BukkitObjectOutputStream.java b/src/main/java/org/bukkit/util/io/BukkitObjectOutputStream.java index 0b073f26..dd1b9ee5 100644 --- a/src/main/java/org/bukkit/util/io/BukkitObjectOutputStream.java +++ b/src/main/java/org/bukkit/util/io/BukkitObjectOutputStream.java @@ -20,7 +20,9 @@ public class BukkitObjectOutputStream extends ObjectOutputStream { /** * Constructor provided to mirror super functionality. * - * @throws IOException if an I/O error occurs while writing stream header + * @throws IOException if an I/O error occurs while creating this stream + * @throws SecurityException if a security manager exists and denies + * enabling subclassing * @see ObjectOutputStream#ObjectOutputStream() */ protected BukkitObjectOutputStream() throws IOException, SecurityException { diff --git a/src/main/javadoc/org/bukkit/util/io/package-info.java b/src/main/java/org/bukkit/util/io/package-info.java similarity index 100% rename from src/main/javadoc/org/bukkit/util/io/package-info.java rename to src/main/java/org/bukkit/util/io/package-info.java diff --git a/src/main/javadoc/org/bukkit/util/noise/package-info.java b/src/main/java/org/bukkit/util/noise/package-info.java similarity index 100% rename from src/main/javadoc/org/bukkit/util/noise/package-info.java rename to src/main/java/org/bukkit/util/noise/package-info.java diff --git a/src/main/javadoc/org/bukkit/util/package-info.java b/src/main/java/org/bukkit/util/package-info.java similarity index 100% rename from src/main/javadoc/org/bukkit/util/package-info.java rename to src/main/java/org/bukkit/util/package-info.java diff --git a/src/main/javadoc/org/bukkit/util/permissions/package-info.java b/src/main/java/org/bukkit/util/permissions/package-info.java similarity index 100% rename from src/main/javadoc/org/bukkit/util/permissions/package-info.java rename to src/main/java/org/bukkit/util/permissions/package-info.java diff --git a/src/main/javadoc/org/bukkit/configuration/file/package-info.java b/src/main/javadoc/org/bukkit/configuration/file/package-info.java deleted file mode 100644 index 4973ffc1..00000000 --- a/src/main/javadoc/org/bukkit/configuration/file/package-info.java +++ /dev/null @@ -1,7 +0,0 @@ -/** - * 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/test/java/org/bukkit/AnnotationTest.java b/src/test/java/org/bukkit/AnnotationTest.java index cc6b6e20..0c737724 100644 --- a/src/test/java/org/bukkit/AnnotationTest.java +++ b/src/test/java/org/bukkit/AnnotationTest.java @@ -200,6 +200,9 @@ public class AnnotationTest { } /** + * Checks if the class is anonymous. + * + * @param clazz the class to check * @return true if given class is anonymous */ private static boolean isAnonymous(@NotNull ClassNode clazz) { diff --git a/src/test/java/org/bukkit/configuration/file/package-info.java b/src/test/java/org/bukkit/configuration/file/package-info.java new file mode 100644 index 00000000..832202cf --- /dev/null +++ b/src/test/java/org/bukkit/configuration/file/package-info.java @@ -0,0 +1,4 @@ +/** + * Test Classes. + */ +package org.bukkit.configuration.file; diff --git a/src/test/java/org/bukkit/configuration/package-info.java b/src/test/java/org/bukkit/configuration/package-info.java new file mode 100644 index 00000000..461f4f9a --- /dev/null +++ b/src/test/java/org/bukkit/configuration/package-info.java @@ -0,0 +1,4 @@ +/** + * Test Classes. + */ +package org.bukkit.configuration; diff --git a/src/test/java/org/bukkit/conversations/package-info.java b/src/test/java/org/bukkit/conversations/package-info.java new file mode 100644 index 00000000..c09e3064 --- /dev/null +++ b/src/test/java/org/bukkit/conversations/package-info.java @@ -0,0 +1,4 @@ +/** + * Test Classes. + */ +package org.bukkit.conversations; diff --git a/src/test/java/org/bukkit/entity/memory/package-info.java b/src/test/java/org/bukkit/entity/memory/package-info.java new file mode 100644 index 00000000..0605a43e --- /dev/null +++ b/src/test/java/org/bukkit/entity/memory/package-info.java @@ -0,0 +1,4 @@ +/** + * Test Classes. + */ +package org.bukkit.entity.memory; diff --git a/src/test/java/org/bukkit/event/package-info.java b/src/test/java/org/bukkit/event/package-info.java new file mode 100644 index 00000000..2e3292d4 --- /dev/null +++ b/src/test/java/org/bukkit/event/package-info.java @@ -0,0 +1,4 @@ +/** + * Test Classes. + */ +package org.bukkit.event; diff --git a/src/test/java/org/bukkit/materials/package-info.java b/src/test/java/org/bukkit/materials/package-info.java new file mode 100644 index 00000000..68ea586c --- /dev/null +++ b/src/test/java/org/bukkit/materials/package-info.java @@ -0,0 +1,4 @@ +/** + * Test Classes. + */ +package org.bukkit.materials; diff --git a/src/test/java/org/bukkit/metadata/MetadataValueAdapterTest.java b/src/test/java/org/bukkit/metadata/MetadataValueAdapterTest.java index 2d545f0e..c1e78568 100644 --- a/src/test/java/org/bukkit/metadata/MetadataValueAdapterTest.java +++ b/src/test/java/org/bukkit/metadata/MetadataValueAdapterTest.java @@ -65,7 +65,12 @@ public class MetadataValueAdapterTest { assertEquals("", simpleValue(null).asString()); } - /** Get a fixed value MetadataValue. */ + /** + * Get a fixed value MetadataValue. + * + * @param value the value to wrap + * @return the fixed value + */ private MetadataValue simpleValue(Object value) { return new FixedMetadataValue(plugin, value); } diff --git a/src/test/java/org/bukkit/metadata/package-info.java b/src/test/java/org/bukkit/metadata/package-info.java new file mode 100644 index 00000000..b13e46f4 --- /dev/null +++ b/src/test/java/org/bukkit/metadata/package-info.java @@ -0,0 +1,4 @@ +/** + * Test Classes. + */ +package org.bukkit.metadata; diff --git a/src/test/java/org/bukkit/package-info.java b/src/test/java/org/bukkit/package-info.java new file mode 100644 index 00000000..80d9c532 --- /dev/null +++ b/src/test/java/org/bukkit/package-info.java @@ -0,0 +1,4 @@ +/** + * Test Classes. + */ +package org.bukkit; diff --git a/src/test/java/org/bukkit/plugin/messaging/package-info.java b/src/test/java/org/bukkit/plugin/messaging/package-info.java new file mode 100644 index 00000000..0fa6275c --- /dev/null +++ b/src/test/java/org/bukkit/plugin/messaging/package-info.java @@ -0,0 +1,4 @@ +/** + * Test Classes. + */ +package org.bukkit.plugin.messaging; diff --git a/src/test/java/org/bukkit/plugin/package-info.java b/src/test/java/org/bukkit/plugin/package-info.java new file mode 100644 index 00000000..d85ab84c --- /dev/null +++ b/src/test/java/org/bukkit/plugin/package-info.java @@ -0,0 +1,4 @@ +/** + * Test Classes. + */ +package org.bukkit.plugin; diff --git a/src/test/java/org/bukkit/util/io/package-info.java b/src/test/java/org/bukkit/util/io/package-info.java new file mode 100644 index 00000000..050c25d9 --- /dev/null +++ b/src/test/java/org/bukkit/util/io/package-info.java @@ -0,0 +1,4 @@ +/** + * Test Classes. + */ +package org.bukkit.util.io; diff --git a/src/test/java/org/bukkit/util/package-info.java b/src/test/java/org/bukkit/util/package-info.java new file mode 100644 index 00000000..310035e1 --- /dev/null +++ b/src/test/java/org/bukkit/util/package-info.java @@ -0,0 +1,4 @@ +/** + * Test Classes. + */ +package org.bukkit.util;