Pulling all pending Bukkit-JavaDoc changes

By: Edmond Poon <sagaciouszzzz@gmail.com>

paper-api/src/main/java/org/bukkit/entity/AnimalTamer.java

@@ -3,6 +3,7 @@ package org.bukkit.entity;
 public interface AnimalTamer {
     /**
      * This is the name of the specified AnimalTamer.
+     *
      * @return The name to reference on tamed animals
      */
     public String getName();

paper-api/src/main/java/org/bukkit/entity/CreatureType.java

@@ -6,6 +6,7 @@ import java.util.Map;
 
 /**
  * Represents a type of creature.
+ *
  * @deprecated Use EntityType instead.
  */
 @Deprecated

paper-api/src/main/java/org/bukkit/entity/EntityType.java

@@ -39,7 +39,7 @@ public enum EntityType {
      */
     ARROW("Arrow", Arrow.class, 10),
     /**
-     * A flyinf snowball.
+     * A flying snowball.
      */
     SNOWBALL("Snowball", Snowball.class, 11),
     /**
@@ -227,6 +227,7 @@ public enum EntityType {
      * Some entities cannot be spawned using {@link World#spawnEntity(Location, EntityType)}
      * or {@link World#spawn(Location, Class)}, usually
      * because they require additional information in order to spawn.
+     *
      * @return False if the entity type cannot be spawned
      */
     public boolean isSpawnable() {

paper-api/src/main/java/org/bukkit/entity/HumanEntity.java

@@ -38,6 +38,7 @@ public interface HumanEntity extends LivingEntity, AnimalTamer, Permissible, Inv
     /**
      * If the player currently has an inventory window open, this method will set a
      * property of that window, such as the state of a progress bar.
+     *
      * @param prop The property.
      * @param value The value to set the property to.
      * @return True if the property was successfully set.
@@ -47,6 +48,7 @@ public interface HumanEntity extends LivingEntity, AnimalTamer, Permissible, Inv
     /**
      * Gets the inventory view the player is currently viewing. If they do not have
      * an inventory window open, it returns their internal crafting view.
+     *
      * @return The inventory view.
      */
     public InventoryView getOpenInventory();
@@ -54,6 +56,7 @@ public interface HumanEntity extends LivingEntity, AnimalTamer, Permissible, Inv
     /**
      * Opens an inventory window with the specified inventory on the top and the player's inventory
      * on the bottom.
+     *
      * @param inventory The inventory to open
      * @return The newly opened inventory view
      */
@@ -61,6 +64,7 @@ public interface HumanEntity extends LivingEntity, AnimalTamer, Permissible, Inv
 
     /**
      * Opens an empty workbench inventory window with the player's inventory on the bottom.
+     *
      * @param location The location to attach it to. If null, the player's location is used.
      * @param force If false, and there is no workbench block at the location, no inventory will be
      * opened and null will be returned.
@@ -70,6 +74,7 @@ public interface HumanEntity extends LivingEntity, AnimalTamer, Permissible, Inv
 
     /**
      * Opens an empty enchanting inventory window with the player's inventory on the bottom.
+     *
      * @param location The location to attach it to. If null, the player's location is used.
      * @param force If false, and there is no enchanting table at the location, no inventory will be
      * opened and null will be returned.
@@ -78,7 +83,8 @@ public interface HumanEntity extends LivingEntity, AnimalTamer, Permissible, Inv
     public InventoryView openEnchanting(Location location, boolean force);
 
     /**
-     * Opens an inventory window to the specified inventory view
+     * Opens an inventory window to the specified inventory view.
+     *
      * @param inventory The view to open
      */
     public void openInventory(InventoryView inventory);

paper-api/src/main/java/org/bukkit/entity/LivingEntity.java

@@ -305,7 +305,7 @@ public interface LivingEntity extends Entity, Damageable {
     public void setRemoveWhenFarAway(boolean remove);
 
     /**
-     *  Gets the inventory with the equipment worn by the living entity.
+     * Gets the inventory with the equipment worn by the living entity.
      *
      * @return the living entity's inventory
      */

paper-api/src/main/java/org/bukkit/entity/Player.java

@@ -596,6 +596,7 @@ public interface Player extends HumanEntity, Conversable, CommandSender, Offline
 
     /**
      * Sets the speed at which a client will fly. Negative values indicate reverse directions.
+     *
      * @param value The new speed, from -1 to 1.
      * @throws IllegalArgumentException If new speed is less than -1 or greater than 1
      */
@@ -603,6 +604,7 @@ public interface Player extends HumanEntity, Conversable, CommandSender, Offline
 
     /**
      * Sets the speed at which a client will walk. Negative values indicate reverse directions.
+     *
      * @param value The new speed, from -1 to 1.
      * @throws IllegalArgumentException If new speed is less than -1 or greater than 1
      */
@@ -610,12 +612,14 @@ public interface Player extends HumanEntity, Conversable, CommandSender, Offline
 
     /**
      * Gets the current allowed speed that a client can fly.
+     *
      * @return The current allowed speed, from -1 to 1
      */
     public float getFlySpeed();
 
     /**
      * Gets the current allowed speed that a client can walk.
+     *
      * @return The current allowed speed, from -1 to 1
      */
     public float getWalkSpeed();

paper-api/src/main/java/org/bukkit/entity/TNTPrimed.java

@@ -26,7 +26,7 @@ public interface TNTPrimed extends Explosive {
      * that this can be null if there is no suitable source.
      * (created by the {@link org.bukkit.World#spawn(Location, Class)}
      * method, for example.)
-     *
+     * <p>
      * The source will become null if the chunk this primed TNT is in
      * is unloaded then reloaded. If the source Entity becomes invalidated
      * for any reason, such being removed from the world, the returned value