From 7d83cba0f2575112577ed7a091ed8a193bfc261a Mon Sep 17 00:00:00 2001 From: md_5 Date: Fri, 4 Mar 2016 16:16:59 +1100 Subject: BUILDTOOLS-203: Fix invalid javadoc --- .../org/bukkit/attribute/AttributeInstance.java | 2 +- .../configuration/file/FileConfiguration.java | 7 -- .../java/org/bukkit/inventory/EntityEquipment.java | 8 +- src/main/java/org/bukkit/material/Door.java | 100 ++++++++++----------- src/main/java/org/bukkit/material/Leaves.java | 4 +- src/main/java/org/bukkit/material/Sapling.java | 2 +- src/main/java/org/bukkit/material/Tree.java | 4 +- src/main/java/org/bukkit/material/Wood.java | 6 +- src/main/java/org/bukkit/material/WoodenStep.java | 2 +- src/main/java/org/bukkit/scoreboard/Team.java | 2 +- 10 files changed, 65 insertions(+), 72 deletions(-) (limited to 'src/main') diff --git a/src/main/java/org/bukkit/attribute/AttributeInstance.java b/src/main/java/org/bukkit/attribute/AttributeInstance.java index 450e0568..92194b35 100644 --- a/src/main/java/org/bukkit/attribute/AttributeInstance.java +++ b/src/main/java/org/bukkit/attribute/AttributeInstance.java @@ -32,7 +32,7 @@ public interface AttributeInstance { /** * Get all modifiers present on this instance. * - * @return + * @return a copied collection of all modifiers */ Collection getModifiers(); diff --git a/src/main/java/org/bukkit/configuration/file/FileConfiguration.java b/src/main/java/org/bukkit/configuration/file/FileConfiguration.java index a037d3e4..5c1a3fde 100644 --- a/src/main/java/org/bukkit/configuration/file/FileConfiguration.java +++ b/src/main/java/org/bukkit/configuration/file/FileConfiguration.java @@ -113,10 +113,6 @@ public abstract class FileConfiguration extends MemoryConfiguration { *

* If the file cannot be loaded for any reason, an exception will be * thrown. - *

- * This will attempt to use the {@link Charset#defaultCharset()} for - * files, unless {@link #UTF8_OVERRIDE} but not {@link #UTF_BIG} is - * specified. * * @param file File to load from. * @throws FileNotFoundException Thrown when the given file cannot be @@ -140,9 +136,6 @@ public abstract class FileConfiguration extends MemoryConfiguration { * All the values contained within this configuration will be removed, * leaving only settings and defaults, and the new values will be loaded * from the given stream. - *

- * This will attempt to use the {@link Charset#defaultCharset()}, unless - * {@link #UTF8_OVERRIDE} or {@link #UTF_BIG} is specified. * * @param stream Stream to load from * @throws IOException Thrown when the given file cannot be read. diff --git a/src/main/java/org/bukkit/inventory/EntityEquipment.java b/src/main/java/org/bukkit/inventory/EntityEquipment.java index fc1c98b3..da1eb4ec 100644 --- a/src/main/java/org/bukkit/inventory/EntityEquipment.java +++ b/src/main/java/org/bukkit/inventory/EntityEquipment.java @@ -139,8 +139,8 @@ public interface EntityEquipment { /** * @deprecated entities can duel wield now use the methods for the specific * hand instead - * @see #getItemInMainHandDropChance(ItemStack) - * @see #getItemInOffHandDropChance(ItemStack) + * @see #getItemInMainHandDropChance() + * @see #getItemInOffHandDropChance() * @return drop chance */ @Deprecated @@ -149,8 +149,8 @@ public interface EntityEquipment { /** * @deprecated entities can duel wield now use the methods for the specific * hand instead - * @see #setItemInMainHandDropChance(ItemStack) - * @see #setItemInOffHandDropChance(ItemStack) + * @see #setItemInMainHandDropChance(float) + * @see #setItemInOffHandDropChance(float) * @param chance drop chance */ @Deprecated diff --git a/src/main/java/org/bukkit/material/Door.java b/src/main/java/org/bukkit/material/Door.java index e02d8e66..07a40a00 100644 --- a/src/main/java/org/bukkit/material/Door.java +++ b/src/main/java/org/bukkit/material/Door.java @@ -11,13 +11,13 @@ import org.bukkit.block.BlockFace; * work with modern doors. Some methods are undefined dependant on isTopHalf() * due to Minecraft's internal representation of doors. * - * @see Material.WOODEN_DOOR - * @see Material.IRON_DOOR_BLOCK - * @see Material.SPRUCE_DOOR - * @see Material.BIRCH_DOOR - * @see Material.JUNGLE_DOOR - * @see Material.ACACIA_DOOR - * @see Material.DARK_OAK_DOOR + * @see Material#WOODEN_DOOR + * @see Material#IRON_DOOR_BLOCK + * @see Material#SPRUCE_DOOR + * @see Material#BIRCH_DOOR + * @see Material#JUNGLE_DOOR + * @see Material#ACACIA_DOOR + * @see Material#DARK_OAK_DOOR */ public class Door extends MaterialData implements Directional, Openable { @@ -51,18 +51,18 @@ public class Door extends MaterialData implements Directional, Openable { * @param type The type of material this door is made of. This must match the type of the block above. * @param face The direction the door is facing. * - * @see Material.WOODEN_DOOR - * @see Material.IRON_DOOR_BLOCK - * @see Material.SPRUCE_DOOR - * @see Material.BIRCH_DOOR - * @see Material.JUNGLE_DOOR - * @see Material.ACACIA_DOOR - * @see Material.DARK_OAK_DOOR + * @see Material#WOODEN_DOOR + * @see Material#IRON_DOOR_BLOCK + * @see Material#SPRUCE_DOOR + * @see Material#BIRCH_DOOR + * @see Material#JUNGLE_DOOR + * @see Material#ACACIA_DOOR + * @see Material#DARK_OAK_DOOR * - * @see BlockFace.WEST - * @see BlockFace.NORTH - * @see BlockFace.EAST - * @see BlockFace.SOUTH + * @see BlockFace#WEST + * @see BlockFace#NORTH + * @see BlockFace#EAST + * @see BlockFace#SOUTH */ public Door(final Material type, BlockFace face) { this(type, face, false); @@ -76,18 +76,18 @@ public class Door extends MaterialData implements Directional, Openable { * @param face The direction the door is facing. * @param isOpen Whether the door is currently opened. * - * @see Material.WOODEN_DOOR - * @see Material.IRON_DOOR_BLOCK - * @see Material.SPRUCE_DOOR - * @see Material.BIRCH_DOOR - * @see Material.JUNGLE_DOOR - * @see Material.ACACIA_DOOR - * @see Material.DARK_OAK_DOOR + * @see Material#WOODEN_DOOR + * @see Material#IRON_DOOR_BLOCK + * @see Material#SPRUCE_DOOR + * @see Material#BIRCH_DOOR + * @see Material#JUNGLE_DOOR + * @see Material#ACACIA_DOOR + * @see Material#DARK_OAK_DOOR * - * @see BlockFace.WEST - * @see BlockFace.NORTH - * @see BlockFace.EAST - * @see BlockFace.SOUTH + * @see BlockFace#WEST + * @see BlockFace#NORTH + * @see BlockFace#EAST + * @see BlockFace#SOUTH */ public Door(final Material type, BlockFace face, boolean isOpen) { super(type); @@ -102,13 +102,13 @@ public class Door extends MaterialData implements Directional, Openable { * @param type The type of material this door is made of. This must match the type of the block below. * @param isHingeRight True if the hinge is on the right hand side, false if the hinge is on the left hand side. * - * @see Material.WOODEN_DOOR - * @see Material.IRON_DOOR_BLOCK - * @see Material.SPRUCE_DOOR - * @see Material.BIRCH_DOOR - * @see Material.JUNGLE_DOOR - * @see Material.ACACIA_DOOR - * @see Material.DARK_OAK_DOOR + * @see Material#WOODEN_DOOR + * @see Material#IRON_DOOR_BLOCK + * @see Material#SPRUCE_DOOR + * @see Material#BIRCH_DOOR + * @see Material#JUNGLE_DOOR + * @see Material#ACACIA_DOOR + * @see Material#DARK_OAK_DOOR */ public Door(final Material type, boolean isHingeRight) { super(type); @@ -125,10 +125,10 @@ public class Door extends MaterialData implements Directional, Openable { * * @see TreeSpecies * - * @see BlockFace.WEST - * @see BlockFace.NORTH - * @see BlockFace.EAST - * @see BlockFace.SOUTH + * @see BlockFace#WEST + * @see BlockFace#NORTH + * @see BlockFace#EAST + * @see BlockFace#SOUTH */ public Door(final TreeSpecies species, BlockFace face) { this(getWoodDoorOfSpecies(species), face, false); @@ -144,10 +144,10 @@ public class Door extends MaterialData implements Directional, Openable { * * @see TreeSpecies * - * @see BlockFace.WEST - * @see BlockFace.NORTH - * @see BlockFace.EAST - * @see BlockFace.SOUTH + * @see BlockFace#WEST + * @see BlockFace#NORTH + * @see BlockFace#EAST + * @see BlockFace#SOUTH */ public Door(final TreeSpecies species, BlockFace face, boolean isOpen) { this(getWoodDoorOfSpecies(species), face, isOpen); @@ -191,12 +191,12 @@ public class Door extends MaterialData implements Directional, Openable { * @param species The species of wood door required. * @return The item type for the given species. * - * @see Material.WOODEN_DOOR - * @see Material.SPRUCE_DOOR - * @see Material.BIRCH_DOOR - * @see Material.JUNGLE_DOOR - * @see Material.ACACIA_DOOR - * @see Material.DARK_OAK_DOOR + * @see Material#WOODEN_DOOR + * @see Material#SPRUCE_DOOR + * @see Material#BIRCH_DOOR + * @see Material#JUNGLE_DOOR + * @see Material#ACACIA_DOOR + * @see Material#DARK_OAK_DOOR */ public static Material getWoodDoorOfSpecies(TreeSpecies species) { switch (species) { diff --git a/src/main/java/org/bukkit/material/Leaves.java b/src/main/java/org/bukkit/material/Leaves.java index 1be14094..904659b1 100644 --- a/src/main/java/org/bukkit/material/Leaves.java +++ b/src/main/java/org/bukkit/material/Leaves.java @@ -7,8 +7,8 @@ import org.bukkit.TreeSpecies; * Represents the different types of leaf block that may be permanent or can * decay when too far from a log. * - * @see Material.LEAVES - * @see Material.LEAVES_2 + * @see Material#LEAVES + * @see Material#LEAVES_2 */ public class Leaves extends Wood { protected static final Material DEFAULT_TYPE = Material.LEAVES; diff --git a/src/main/java/org/bukkit/material/Sapling.java b/src/main/java/org/bukkit/material/Sapling.java index 52dbaee8..08ef2de7 100644 --- a/src/main/java/org/bukkit/material/Sapling.java +++ b/src/main/java/org/bukkit/material/Sapling.java @@ -6,7 +6,7 @@ import org.bukkit.TreeSpecies; /** * Represents the different types of Tree block that face a direction. * - * @see Material.SAPLING + * @see Material#SAPLING */ public class Sapling extends Wood { diff --git a/src/main/java/org/bukkit/material/Tree.java b/src/main/java/org/bukkit/material/Tree.java index 8bc79af1..e28499d0 100644 --- a/src/main/java/org/bukkit/material/Tree.java +++ b/src/main/java/org/bukkit/material/Tree.java @@ -7,8 +7,8 @@ import org.bukkit.block.BlockFace; /** * Represents the different types of Tree block that face a direction. * - * @see Material.LOG - * @see Material.LOG_2 + * @see Material#LOG + * @see Material#LOG_2 */ public class Tree extends Wood { protected static final Material DEFAULT_TYPE = Material.LOG; diff --git a/src/main/java/org/bukkit/material/Wood.java b/src/main/java/org/bukkit/material/Wood.java index 1c401621..794cfd4d 100644 --- a/src/main/java/org/bukkit/material/Wood.java +++ b/src/main/java/org/bukkit/material/Wood.java @@ -6,9 +6,9 @@ import org.bukkit.TreeSpecies; /** * Represents wood blocks of different species. * - * @see Material.WOOD - * @see Material.SAPLING - * @see Material.WOOD_DOUBLE_STEP + * @see Material#WOOD + * @see Material#SAPLING + * @see Material#WOOD_DOUBLE_STEP */ public class Wood extends MaterialData { protected static final Material DEFAULT_TYPE = Material.WOOD; diff --git a/src/main/java/org/bukkit/material/WoodenStep.java b/src/main/java/org/bukkit/material/WoodenStep.java index 293c95b1..17b7050e 100644 --- a/src/main/java/org/bukkit/material/WoodenStep.java +++ b/src/main/java/org/bukkit/material/WoodenStep.java @@ -6,7 +6,7 @@ import org.bukkit.TreeSpecies; /** * Represents the different types of wooden steps. * - * @see Material.WOOD_STEP + * @see Material#WOOD_STEP */ public class WoodenStep extends Wood { protected static final Material DEFAULT_TYPE = Material.WOOD_STEP; diff --git a/src/main/java/org/bukkit/scoreboard/Team.java b/src/main/java/org/bukkit/scoreboard/Team.java index bddc8482..9052b4a0 100644 --- a/src/main/java/org/bukkit/scoreboard/Team.java +++ b/src/main/java/org/bukkit/scoreboard/Team.java @@ -115,7 +115,7 @@ public interface Team { * * @return the current name tag visibilty for the team * @throws IllegalArgumentException if this team has been unregistered - * @deprecated see {@link #getOption()} + * @deprecated see {@link #getOption(org.bukkit.scoreboard.Team.Option)} */ @Deprecated NameTagVisibility getNameTagVisibility() throws IllegalArgumentException; -- cgit v1.2.3