Many javadoc fixes thanks to Celtic Minstrel

By: Dinnerbone <dinnerbone@dinnerbone.com>

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

@@ -10,14 +10,14 @@ public interface Boat extends Vehicle {
     /**
      * Gets the maximum speed of a boat. The speed is unrelated to the velocity.
      *
-     * @param speed
+     * @return The max speed.
      */
     public double getMaxSpeed();
 
     /**
      * Sets the maximum speed of a boat. Must be nonnegative. Default is 0.4D.
      *
-     * @param speed
+     * @param speed The max speed.
      */
     public void setMaxSpeed(double speed);
 }

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

@@ -92,7 +92,7 @@ public interface Entity {
     /**
      * Sets the entity's current fire ticks (ticks before the entity stops being on fire).
      *
-     * @param ticks
+     * @param ticks Current ticks remaining
      */
     public void setFireTicks(int ticks);
 
@@ -103,6 +103,7 @@ public interface Entity {
 
     /**
      * Returns true if this entity has been marked for removal.
+     * @return True if it is dead.
      */
     public boolean isDead();
 
@@ -124,34 +125,34 @@ public interface Entity {
     /**
      * Set the passenger of a vehicle.
      *
-     * @param passenger
+     * @param passenger The new passenger.
      * @return false if it could not be done for whatever reason
      */
     public abstract boolean setPassenger(Entity passenger);
 
     /**
-     * Returns true if the vehicle has no passengers.
+     * Check if a vehicle has passengers.
      *
-     * @return
+     * @return True if the vehicle has no passengers.
      */
     public abstract boolean isEmpty();
 
     /**
-     * Eject any passenger. True if there was a passenger.
+     * Eject any passenger.
      *
-     * @return
+     * @return True if there was a passenger.
      */
     public abstract boolean eject();
 
     /**
      * Returns the distance this entity has fallen
-     * @return
+     * @return The distance.
      */
     public float getFallDistance();
 
     /**
      * Sets the fall distance for this entity
-     * @param distance
+     * @param distance The new distance.
      */
     public void setFallDistance(float distance);
 

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

@@ -6,7 +6,7 @@ package org.bukkit.entity;
 public interface Explosive extends Entity {
     /**
      * Set the radius affected by this explosive's explosion
-     * @param yield
+     * @param yield The explosive yield
      */
     public void setYield(float yield);
 
@@ -18,7 +18,7 @@ public interface Explosive extends Entity {
 
     /**
      * Set whether or not this explosive's explosion causes fire
-     * @param isIncendiary
+     * @param isIncendiary Whether it should cause fire
      */
     public void setIsIncendiary(boolean isIncendiary);
 

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

@@ -36,7 +36,6 @@ public interface HumanEntity extends LivingEntity, AnimalTamer, Permissible {
      * user was holding.
      *
      * @param item The ItemStack which will end up in the hand
-     * @return
      */
     public void setItemInHand(ItemStack item);
 

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

@@ -13,14 +13,14 @@ public interface Item extends Entity {
     /**
      * Gets the item stack associated with this item drop.
      *
-     * @return
+     * @return An item stack.
      */
     public ItemStack getItemStack();
 
     /**
      * Sets the item stack associated with this item drop.
      *
-     * @param stack
+     * @param stack An item stack.
      */
     public void setItemStack(ItemStack stack);
 }

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

@@ -35,7 +35,7 @@ public interface LivingEntity extends Entity {
     /**
      * Gets the height of the entity's head above its Location
      *
-     * @param boolean If set to true, the effects of sneaking will be ignored
+     * @param ignoreSneaking If set to true, the effects of sneaking will be ignored
      * @return Height of the entity's eyes above its Location
      */
     public double getEyeHeight(boolean ignoreSneaking);
@@ -51,8 +51,8 @@ public interface LivingEntity extends Entity {
      * Gets all blocks along the player's line of sight
      * List iterates from player's position to target inclusive
      *
-     * @param HashSet<Byte> HashSet containing all transparent block IDs. If set to null only air is considered transparent.
-     * @param int This is the maximum distance to scan. This may be further limited by the server, but never to less than 100 blocks.
+     * @param transparent HashSet containing all transparent block IDs. If set to null only air is considered transparent.
+     * @param maxDistance This is the maximum distance to scan. This may be further limited by the server, but never to less than 100 blocks.
      * @return List containing all blocks along the player's line of sight
      */
     public List<Block> getLineOfSight(HashSet<Byte> transparent, int maxDistance);
@@ -60,8 +60,8 @@ public interface LivingEntity extends Entity {
     /**
      * Gets the block that the player has targeted
      *
-     * @param HashSet<Byte> HashSet containing all transparent block IDs. If set to null only air is considered transparent.
-     * @param int This is the maximum distance to scan. This may be further limited by the server, but never to less than 100 blocks.
+     * @param transparent HashSet containing all transparent block IDs. If set to null only air is considered transparent.
+     * @param maxDistance This is the maximum distance to scan. This may be further limited by the server, but never to less than 100 blocks.
      * @return Block that the player has targeted
      */
     public Block getTargetBlock(HashSet<Byte> transparent, int maxDistance);
@@ -70,33 +70,35 @@ public interface LivingEntity extends Entity {
      * Gets the last two blocks along the player's line of sight.
      * The target block will be the last block in the list.
      *
-     * @param HashSet<Byte> HashSet containing all transparent block IDs. If set to null only air is considered transparent.
-     * @param int This is the maximum distance to scan. This may be further limited by the server, but never to less than 100 blocks
+     * @param transparent HashSet containing all transparent block IDs. If set to null only air is considered transparent.
+     * @param maxDistance This is the maximum distance to scan. This may be further limited by the server, but never to less than 100 blocks
      * @return List containing the last 2 blocks along the player's line of sight
      */
     public List<Block> getLastTwoTargetBlocks(HashSet<Byte> transparent, int maxDistance);
 
     /**
      * Throws an egg from the entity.
+     * @return The egg thrown.
      */
     public Egg throwEgg();
 
     /**
      * Throws a snowball from the entity.
+     * @return The snowball thrown.
      */
     public Snowball throwSnowball();
 
     /**
      * Shoots an arrow from the entity.
      *
-     * @return
+     * @return The arrow shot.
      */
     public Arrow shootArrow();
 
     /**
      * Returns whether this entity is inside a vehicle.
      *
-     * @return
+     * @return True if the entity is in a vehicle.
      */
     public boolean isInsideVehicle();
 
@@ -105,7 +107,7 @@ public interface LivingEntity extends Entity {
      * (and is removed from it), true will be returned, otherwise false will
      * be returned.
      *
-     * @return
+     * @return True if the entity was in a vehicle.
      */
     public boolean leaveVehicle();
 
@@ -113,7 +115,7 @@ public interface LivingEntity extends Entity {
      * Get the vehicle that this player is inside. If there is no vehicle,
      * null will be returned.
      *
-     * @return
+     * @return The current vehicle.
      */
     public Vehicle getVehicle();
 

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

@@ -19,34 +19,35 @@ public interface Minecart extends Vehicle {
     /**
      * Gets a minecart's damage.
      *
-     * @param damage
+     * @return The damage
      */
     public int getDamage();
 
     /**
      * Gets the maximum speed of a minecart. The speed is unrelated to the velocity.
-     *
-     * @param speed
+     * 
+     * @return The max speed
      */
     public double getMaxSpeed();
 
     /**
      * Sets the maximum speed of a minecart. Must be nonnegative. Default is 0.4D.
      *
-     * @param speed
+     * @param speed The max speed
      */
     public void setMaxSpeed(double speed);
 
     /**
      * Returns whether this minecart will slow down faster without a passenger occupying it
      *
+     * @return Whether it decelerates faster
      */
     public boolean isSlowWhenEmpty();
 
     /**
      * Sets whether this minecart will slow down faster without a passenger occupying it
      *
-     * @param slow
+     * @param slow Whether it will decelerate faster
      */
     public void setSlowWhenEmpty(boolean slow);
 
@@ -54,7 +55,7 @@ public interface Minecart extends Vehicle {
      * Gets the flying velocity modifier. Used for minecarts that are in mid-air.
      * A flying minecart's velocity is multiplied by this factor each tick.
      *
-     * @param flying velocity modifier
+     * @return The vector factor
      */
     public Vector getFlyingVelocityMod();
 
@@ -62,7 +63,7 @@ public interface Minecart extends Vehicle {
      * Sets the flying velocity modifier. Used for minecarts that are in mid-air.
      * A flying minecart's velocity is multiplied by this factor each tick.
      *
-     * @param flying velocity modifier
+     * @param flying velocity modifier vector
      */
     public void setFlyingVelocityMod(Vector flying);
 
@@ -70,7 +71,7 @@ public interface Minecart extends Vehicle {
      * Gets the derailed velocity modifier. Used for minecarts that are on the ground, but not on rails.
      *
      * A derailed minecart's velocity is multiplied by this factor each tick.
-     * @param visible speed
+     * @return derailed visible speed
      */
     public Vector getDerailedVelocityMod();
 
@@ -78,7 +79,7 @@ public interface Minecart extends Vehicle {
      * Sets the derailed velocity modifier. Used for minecarts that are on the ground, but not on rails.
      * A derailed minecart's velocity is multiplied by this factor each tick.
      *
-     * @param visible speed
+     * @param derailed visible speed
      */
     public void setDerailedVelocityMod(Vector derailed);
 }

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

@@ -33,14 +33,14 @@ public interface Player extends HumanEntity, CommandSender, OfflinePlayer {
      * Note that this name will not be displayed in game, only in chat and places
      * defined by plugins
      *
-     * @param name
+     * @param name The new display name.
      */
     public void setDisplayName(String name);
 
     /**
      * Set the target of the player's compass.
      *
-     * @param loc
+     * @param loc Location to point to
      */
     public void setCompassTarget(Location loc);
 
@@ -130,14 +130,14 @@ public interface Player extends HumanEntity, CommandSender, OfflinePlayer {
      * next day. If everyone has this flag set but no one is actually in bed,
      * then nothing will happen.
      *
-     * @param isSleeping
+     * @param isSleeping Whether to ignore.
      */
     public void setSleepingIgnored(boolean isSleeping);
 
     /**
      * Returns whether the player is sleeping ignored.
      *
-     * @return
+     * @return Whether player is ignoring sleep.
      */
     public boolean isSleepingIgnored();
 
@@ -146,9 +146,9 @@ public interface Player extends HumanEntity, CommandSender, OfflinePlayer {
      * at the particular location (as far as the client is concerned). This
      * will not work without a note block. This will not work with cake.
      *
-     * @param loc
-     * @param instrument
-     * @param note
+     * @param loc The location of a note block.
+     * @param instrument The instrument ID.
+     * @param note The note ID.
      */
     public void playNote(Location loc, byte instrument, byte note);
 
@@ -157,16 +157,16 @@ public interface Player extends HumanEntity, CommandSender, OfflinePlayer {
      * at the particular location (as far as the client is concerned). This
      * will not work without a note block. This will not work with cake.
      *
-     * @param loc
-     * @param instrument
-     * @param note
+     * @param loc The location of a note block
+     * @param instrument The instrument
+     * @param note The note
      */
     public void playNote(Location loc, Instrument instrument, Note note);
 
     /**
      * Plays an effect to just this player.
      *
-     * @param loc the player to play the effect for
+     * @param loc the location to play the effect at
      * @param effect the {@link Effect}
      * @param data a data bit needed for the RECORD_PLAY, SMOKE, and STEP_SOUND sounds
      */
@@ -176,9 +176,9 @@ public interface Player extends HumanEntity, CommandSender, OfflinePlayer {
      * Send a block change. This fakes a block change packet for a user at
      * a certain location. This will not actually change the world in any way.
      *
-     * @param loc
-     * @param material
-     * @param data
+     * @param loc The location of the changed block
+     * @param material The new block
+     * @param data The block data
      */
     public void sendBlockChange(Location loc, Material material, byte data);
 
@@ -205,9 +205,9 @@ public interface Player extends HumanEntity, CommandSender, OfflinePlayer {
      * Send a block change. This fakes a block change packet for a user at
      * a certain location. This will not actually change the world in any way.
      *
-     * @param loc
-     * @param material
-     * @param data
+     * @param loc The location of the changed block
+     * @param material The new block ID
+     * @param data The block data
      */
     public void sendBlockChange(Location loc, int material, byte data);
 
@@ -215,7 +215,7 @@ public interface Player extends HumanEntity, CommandSender, OfflinePlayer {
      * Render a map and send it to the player in its entirety. This may be used
      * when streaming the map in the normal manner is not desirbale.
      *
-     * @pram map The map to be sent
+     * @param map The map to be sent
      */
     public void sendMap(MapView map);
 
@@ -281,7 +281,7 @@ public interface Player extends HumanEntity, CommandSender, OfflinePlayer {
     /**
      * Returns the player's current timestamp.
      *
-     * @return
+     * @return The player's time
      */
     public long getPlayerTime();
 
@@ -289,7 +289,7 @@ public interface Player extends HumanEntity, CommandSender, OfflinePlayer {
      * Returns the player's current time offset relative to server time, or the current player's fixed time
      * if the player's time is absolute.
      *
-     * @return
+     * @return The player's time
      */
     public long getPlayerTimeOffset();
 
@@ -332,7 +332,7 @@ public interface Player extends HumanEntity, CommandSender, OfflinePlayer {
     /**
      * Sets the players current experience level
      *
-     * @param exp New experience level
+     * @param level New experience level
      */
     public void setLevel(int level);
 

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

@@ -1,5 +1,7 @@
 package org.bukkit.entity;
 
+import org.bukkit.block.Dispenser;
+
 /**
  * Represents a shootable entity
  */

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

@@ -6,7 +6,7 @@ package org.bukkit.entity;
 public interface TNTPrimed extends Explosive {
     /**
      * Set the number of ticks until the TNT blows up after being primed.
-     * @param fuseTicks
+     * @param fuseTicks The fuse ticks
      */
     public void setFuseTicks(int fuseTicks);