Forráskód Böngészése

Javadoc update & fixes

bm01 12 éve
szülő
commit
9689c50603

+ 9 - 9
src/main/java/com/gmail/nossr50/skills/woodcutting/TreeFeller.java

@@ -29,7 +29,7 @@ public abstract class TreeFeller {
     private static boolean treeFellerReachedThreshold = false;
 
     /**
-     * Handle the Tree Feller ability.
+     * Begins Tree Feller
      *
      * @param event Event to process
      */
@@ -60,11 +60,11 @@ public abstract class TreeFeller {
             return;
         }
 
-        removeBlocks(treeFellerBlocks, player);
+        dropBlocks(treeFellerBlocks, player);
     }
 
     /**
-     * Process Tree Feller
+     * Processes Tree Feller
      *
      * @param block Point of origin of the layer
      * @param treeFellerBlocks List of blocks to be removed
@@ -115,11 +115,11 @@ public abstract class TreeFeller {
     }
 
     /**
-     * Add a block to the block list
+     * Adds a block to the list of blocks to be removed
      *
      * @param block Block to be added
      * @param treeFellerBlocks List of blocks to be removed
-     * @return True if block was added
+     * @return True if 'block' was added
      */
     private static boolean addBlock(Block block, List<Block> treeFellerBlocks) {
         if (BlockChecks.treeFellerCompatible(block) && !treeFellerBlocks.contains(block) && !mcMMO.placeStore.isTrue(block)) {
@@ -136,7 +136,7 @@ public abstract class TreeFeller {
     }
 
     /**
-     * Handle the durability loss
+     * Handles the durability loss
      *
      * @param treeFellerBlocks List of blocks to be removed
      * @param Player Player using the ability
@@ -170,12 +170,12 @@ public abstract class TreeFeller {
     }
 
     /**
-     * Handles removing & dropping the blocks
+     * Handles the dropping of blocks
      *
-     * @param treeFellerBlocks List of blocks to be removed
+     * @param treeFellerBlocks List of blocks to be dropped
      * @param player Player using the ability
      */
-    private static void removeBlocks(List<Block> treeFellerBlocks, Player player) {
+    private static void dropBlocks(List<Block> treeFellerBlocks, Player player) {
         int xp = 0;
 
         for (Block block : treeFellerBlocks) {

+ 6 - 6
src/main/java/com/gmail/nossr50/skills/woodcutting/Woodcutting.java

@@ -29,7 +29,7 @@ public abstract class Woodcutting {
     public static final boolean DOUBLE_DROP_DISABLED = Config.getInstance().woodcuttingDoubleDropsDisabled();
 
     /**
-     * Begin Tree Feller ability
+     * Begins the Tree Feller ability
      *
      * @param event Event to process
      */
@@ -38,7 +38,7 @@ public abstract class Woodcutting {
     }
 
     /**
-     * Begin Leaf Blower ability.
+     * Begins the Leaf Blower ability
      *
      * @param player Player using the ability
      * @param block Block being broken
@@ -52,7 +52,7 @@ public abstract class Woodcutting {
     }
 
     /**
-     * Begin Woodcutting process
+     * Begins Woodcutting
      *
      * @param player Player breaking the block
      * @param block Block being broken
@@ -77,7 +77,7 @@ public abstract class Woodcutting {
     }
 
     /**
-     * Retrieve the experience from a log
+     * Retrieves the experience reward from a log
      *
      * @param log Log being broken
      * @return Amount of experience
@@ -107,7 +107,7 @@ public abstract class Woodcutting {
     }
 
     /**
-     * Check for double drops
+     * Checks for double drops
      *
      * @param player Player breaking the block
      * @param block Block being broken
@@ -174,7 +174,7 @@ public abstract class Woodcutting {
     }
 
     /**
-     * Extract the log type from the block data (remove rotation)
+     * Extracts the log type from the block data (i.e. removes rotation)
      *
      * @param data Original block data
      * @return Extracted log type