Javadocs cleanup

src/main/java/com/gmail/nossr50/util/Misc.java

@@ -99,7 +99,7 @@ public final class Misc {
      * @param first The first location
      * @param second The second location
      * @param maxDistance The max distance apart
-     * @return true if the distance between <code>first</code> and <code>second</code> is less than <code>maxDistance</code>, false otherwise
+     * @return true if the distance between {@code first} and {@code second} is less than {@code maxDistance}, false otherwise
      */
     public static boolean isNear(Location first, Location second, double maxDistance) {
         if (first.getWorld() != second.getWorld()) {
@@ -142,11 +142,10 @@ public final class Misc {
     }
 
     /**
-     * Randomly drop items at a given location.
+     * Drop items with random quantity at a given location.
      *
      * @param location The location to drop the items at
      * @param is The item to drop
-     * @param chance The percentage chance for the item to drop
      * @param quantity The amount of items to drop
      */
     public static void randomDropItems(Location location, ItemStack is, int quantity) {

src/main/java/com/gmail/nossr50/util/ModUtils.java

@@ -83,7 +83,7 @@ public final class ModUtils {
     /**
      * Check if a custom block is a woodcutting block.
      *
-     * @param block The block to check
+     * @param blockState The BlockState of the block to check
      * @return true if the block represents a log, false otherwise
      */
     public static boolean isCustomWoodcuttingBlock(BlockState blockState) {
@@ -105,7 +105,7 @@ public final class ModUtils {
     /**
      * Check if a custom block should not activate abilites.
      *
-     * @param block The block to check
+     * @param blockState The BlockState of the block to check
      * @return true if the block represents an ability block, false otherwise
      */
     public static boolean isCustomAbilityBlock(BlockState blockState) {
@@ -127,7 +127,7 @@ public final class ModUtils {
     /**
      * Check if a custom block is a mining block.
      *
-     * @param block The block to check
+     * @param blockState The BlockState of the block to check
      * @return true if the block is custom, false otherwise
      */
     public static boolean isCustomMiningBlock(BlockState blockState) {
@@ -149,7 +149,7 @@ public final class ModUtils {
     /**
      * Check if a custom block is an excavation block.
      *
-     * @param block The block to check
+     * @param blockState The BlockState of the block to check
      * @return true if the block is custom, false otherwise
      */
     public static boolean isCustomExcavationBlock(BlockState blockState) {
@@ -193,7 +193,7 @@ public final class ModUtils {
     /**
      * Check if a custom block is a leaf block.
      *
-     * @param block The block to check
+     * @param blockState The BlockState of the block to check
      * @return true if the block represents leaves, false otherwise
      */
     public static boolean isCustomLeafBlock(BlockState blockState) {
@@ -215,7 +215,7 @@ public final class ModUtils {
     /**
      * Check if a custom block is a log block.
      *
-     * @param block The block to check
+     * @param blockState The BlockState of the block to check
      * @return true if the block represents a log, false otherwise
      */
     public static boolean isCustomLogBlock(BlockState blockState) {

src/main/java/com/gmail/nossr50/util/blockmeta/chunkmeta/ChunkManager.java

@@ -136,7 +136,7 @@ public interface ChunkManager {
     /**
      * Check to see if a given BlockState location is set to true
      *
-     * @param location BlockState location to check
+     * @param blockState BlockState to check
      * @return true if the given BlockState location is set to true, false if otherwise
      */
     public boolean isTrue(BlockState blockState);
@@ -161,7 +161,7 @@ public interface ChunkManager {
     /**
      * Set a given BlockState location to true, should create stores as necessary if the location does not exist
      *
-     * @param block BlockState location to set
+     * @param blockState BlockState location to set
      */
     public void setTrue(BlockState blockState);
 
@@ -185,7 +185,7 @@ public interface ChunkManager {
     /**
      * Set a given BlockState location to false, should not create stores if one does not exist for the given location
      *
-     * @param block BlockState location to set
+     * @param blockState BlockState location to set
      */
     public void setFalse(BlockState blockState);
 

src/main/java/com/gmail/nossr50/util/skills/PerksUtils.java

@@ -66,8 +66,9 @@ public final class PerksUtils {
     /**
      * Calculate activation chance for a skill.
      *
-     * @param isLucky true if the player has the appropriate "lucky" perk, false otherwise
-     * @return the activation chance
+     * @param player Player to check the activation chance for
+     * @param skill SkillType to check the activation chance of
+     * @return the activation chance with "lucky perk" accounted for
      */
     public static int handleLuckyPerks(Player player, SkillType skill) {
         if (Permissions.lucky(player, skill)) {