BUILDTOOLS-203: Fix invalid javadoc

By: md_5 <git@md-5.net>
2025-01-24 01:01:58 +01:00 · 2016-03-04 16:16:59 +11:00 · 2016-03-04 16:16:59 +11:00 · ad7fee9850
commit ad7fee9850
parent d1a778a07c
10 changed files with 65 additions and 72 deletions
--- a/paper-api/src/main/java/org/bukkit/attribute/AttributeInstance.java
+++ b/paper-api/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<AttributeModifier> getModifiers();

--- a/paper-api/src/main/java/org/bukkit/configuration/file/FileConfiguration.java
+++ b/paper-api/src/main/java/org/bukkit/configuration/file/FileConfiguration.java
@ -113,10 +113,6 @@ public abstract class FileConfiguration extends MemoryConfiguration {
     * <p>
     * If the file cannot be loaded for any reason, an exception will be
     * thrown.
-     * <p>
-     * 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.
-     * <p>
-     * 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.
--- a/paper-api/src/main/java/org/bukkit/inventory/EntityEquipment.java
+++ b/paper-api/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
--- a/paper-api/src/main/java/org/bukkit/material/Door.java
+++ b/paper-api/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 <code>isTopHalf()</code>
 * 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) {
--- a/paper-api/src/main/java/org/bukkit/material/Leaves.java
+++ b/paper-api/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;
--- a/paper-api/src/main/java/org/bukkit/material/Sapling.java
+++ b/paper-api/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 {

--- a/paper-api/src/main/java/org/bukkit/material/Tree.java
+++ b/paper-api/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;
--- a/paper-api/src/main/java/org/bukkit/material/Wood.java
+++ b/paper-api/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;
--- a/paper-api/src/main/java/org/bukkit/material/WoodenStep.java
+++ b/paper-api/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;
--- a/paper-api/src/main/java/org/bukkit/scoreboard/Team.java
+++ b/paper-api/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;