Fix a handful of Javadoc issues - need to check through the rest later to ensure that we actually have updated JDs for everything

This commit is contained in:
GJ
2013-01-30 19:42:40 -05:00
parent a1d710fe3d
commit cd35df17ec
20 changed files with 33 additions and 43 deletions

View File

@ -56,7 +56,7 @@ public class Archery {
/**
* Check for arrow retrieval.
*
* @param entity The entity hit by the arrows
* @param livingEntity The entity hit by the arrows
*/
public static void arrowRetrievalCheck(LivingEntity livingEntity) {
for (Iterator<TrackedEntity> entityIterator = trackedEntities.iterator(); entityIterator.hasNext(); ) {

View File

@ -60,7 +60,8 @@ public class AxeManager extends SkillManager {
/**
* Check for Skull Splitter ability.
*
* @param event The event to process
* @param target The entity hit by Skull Splitter
* @param damage The base damage to deal
*/
public void skullSplitter(LivingEntity target, int damage) {
SkullSplitterEventHandler eventHandler = new SkullSplitterEventHandler(player, damage, target);

View File

@ -35,9 +35,6 @@ public class MiningBlockEventHandler {
/**
* Process Mining block drops.
*
* @param player The player mining the block
* @param block The block being broken
*/
protected void processDrops() {
if (player.getItemInHand().containsEnchantment(Enchantment.SILK_TOUCH)) {

View File

@ -23,8 +23,6 @@ public class MiningManager extends SkillManager{
* Detonate TNT for Blast Mining
*
* @param event The PlayerInteractEvent
* @param player Player detonating the TNT
* @param plugin mcMMO plugin instance
*/
public void detonate(PlayerInteractEvent event) {
if (skillLevel < BlastMining.rank1) {
@ -92,7 +90,6 @@ public class MiningManager extends SkillManager{
/**
* Increases the blast radius of the explosion.
*
* @param player Player triggering the explosion
* @param event Event whose explosion radius is being changed
*/
public void biggerBombs(ExplosionPrimeEvent event) {
@ -129,7 +126,6 @@ public class MiningManager extends SkillManager{
/**
* Handle the Super Breaker ability.
*
* @param player The player using the ability
* @param block The block being affected
*/
public void superBreakerBlockCheck(Block block) {

View File

@ -42,10 +42,8 @@ public class Repair {
*
* @param player Player repairing the item
* @param profile PlayerProfile of the repairing player
* @param is Item being repaired
* @param durabilityBefore Durability of the item before repair
* @param modify Amount to modify the durability by
* @param boost True if the modifier is a boost, false if the modifier is a reduction
*/
protected static void xpHandler(Player player, PlayerProfile profile, short durabilityBefore, short durabilityAfter, double modify) {
short dif = (short) (durabilityBefore - durabilityAfter);

View File

@ -16,7 +16,7 @@ public interface RepairManager {
/**
* Register a list of repairables with the RepairManager
*
* @param repairable List<Repairable> to register
* @param repairables List<Repairable> to register
*/
public void registerRepairables(List<Repairable> repairables);

View File

@ -36,7 +36,6 @@ public class BeastLoreEventHandler {
/**
* Get the name of a tameable animal's owner.
*
* @param beast The animal whose owner's name to get
* @return the name of the animal's owner
*/
private String getOwnerName() {

View File

@ -40,7 +40,6 @@ public class UnarmedManager extends SkillManager {
/**
* Check for arrow deflection.
*
* @param defender The defending player
* @param event The event to modify
*/
public void deflectCheck(EntityDamageEvent event) {

View File

@ -181,7 +181,7 @@ public enum AbilityType {
/**
* Check if a block is affected by this ability.
*
* @param Block the block to check
* @param block the block to check
* @return true if the block is affected by this ability, false otherwise
*/
public boolean blockCheck(Block block) {

View File

@ -554,7 +554,7 @@ public final class CombatTools {
* Check to see if the given LivingEntity should be affected by a combat ability.
*
* @param player The attacking Player
* @param livingEntity The defending LivingEntity
* @param entity The defending Entity
* @return true if the Entity should be damaged, false otherwise.
*/
public static boolean shouldBeAffected(Player player, Entity entity) {

View File

@ -312,7 +312,7 @@ public class SkillTools {
/**
* Checks if the given string represents a valid skill
*
* @param skillname The name of the skill to check
* @param skillName The name of the skill to check
* @return true if this is a valid skill, false otherwise
*/
public static boolean isSkill(String skillName) {

View File

@ -138,7 +138,7 @@ public enum SkillType {
* Get the skill level for this skill.
*
* @param player The player to check
* @return
* @return the player's skill level
*/
public int getSkillLevel(Player player) {
return Users.getProfile(player).getSkillLevel(this);

View File

@ -129,7 +129,7 @@ public final class TreeFeller {
* Handles the durability loss
*
* @param treeFellerBlocks List of blocks to be removed
* @param Player Player using the ability
* @param player Player using the ability
* @return True if the tool can sustain the durability loss
*/
private static boolean handleDurabilityLoss(List<Block> treeFellerBlocks, Player player) {