Browse Source

Fix Javadocs issues

TfT_02 11 years ago
parent
commit
9c54f8fd11

+ 4 - 3
src/main/java/com/gmail/nossr50/skills/archery/ArcheryManager.java

@@ -41,6 +41,7 @@ public class ArcheryManager extends SkillManager {
      * Calculate bonus XP awarded for Archery when hitting a far-away target.
      *
      * @param target The {@link LivingEntity} damaged by the arrow
+     * @param damager The {@link Entity} who shot the arrow
      */
     public void distanceXpBonus(LivingEntity target, Entity damager) {
         Location firedLocation = Archery.stringToLocation(damager.getMetadata(mcMMO.arrowDistanceKey).get(0).asString());
@@ -68,8 +69,7 @@ public class ArcheryManager extends SkillManager {
      * Handle the effects of the Daze ability
      *
      * @param defender The {@link Player} being affected by the ability
-     * @param damage The amount of damage initially dealt by the event
-     * @return the modified event damage if the ability was successful, the original event damage otherwise
+     * @param arrow The {@link Arrow} that was fired
      */
     public void daze(Player defender, Arrow arrow) {
         if (!SkillUtils.activationSuccessful(getSkillLevel(), getActivationChance(), Archery.dazeMaxBonus, Archery.dazeMaxBonusLevel)) {
@@ -96,8 +96,9 @@ public class ArcheryManager extends SkillManager {
     /**
      * Handle the effects of the Skill Shot ability
      *
+     * @param target The {@link LivingEntity} being affected by the ability
      * @param damage The amount of damage initially dealt by the event
-     * @return the modified event damage
+     * @param arrow The {@link Arrow} that was fired
      */
     public void skillShot(LivingEntity target, double damage, Arrow arrow) {
         double damageBonusPercent = Math.min(((getSkillLevel() / Archery.skillShotIncreaseLevel) * Archery.skillShotIncreasePercentage), Archery.skillShotMaxBonusPercentage);

+ 1 - 5
src/main/java/com/gmail/nossr50/skills/axes/AxesManager.java

@@ -52,8 +52,7 @@ public class AxesManager extends SkillManager {
     /**
      * Handle the effects of the Axe Mastery ability
      *
-     * @param damage The amount of damage initially dealt by the event
-     * @return the modified event damage
+     * @param target The {@link LivingEntity} being affected by the ability
      */
     public void axeMastery(LivingEntity target) {
         double axeBonus = Math.min(getSkillLevel() / (Axes.bonusDamageMaxBonusLevel / Axes.bonusDamageMaxBonus), Axes.bonusDamageMaxBonus);
@@ -66,7 +65,6 @@ public class AxesManager extends SkillManager {
      *
      * @param target The {@link LivingEntity} being affected by the ability
      * @param damage The amount of damage initially dealt by the event
-     * @return the modified event damage if the ability was successful, the original event damage otherwise
      */
     public void criticalHit(LivingEntity target, double damage) {
         if (!SkillUtils.activationSuccessful(getSkillLevel(), getActivationChance(), Axes.criticalHitMaxChance, Axes.criticalHitMaxBonusLevel)) {
@@ -113,8 +111,6 @@ public class AxesManager extends SkillManager {
      * Handle the effects of the Greater Impact ability
      *
      * @param target The {@link LivingEntity} being affected by the ability
-     * @param damage The amount of damage initially dealt by the event
-     * @return the modified event damage if the ability was successful, the original event damage otherwise
      */
     public void greaterImpact(LivingEntity target) {
         if (!(Axes.greaterImpactChance > Misc.getRandom().nextInt(getActivationChance()))) {

+ 12 - 0
src/main/java/com/gmail/nossr50/skills/swords/SwordsManager.java

@@ -66,6 +66,12 @@ public class SwordsManager extends SkillManager {
         }
     }
 
+    /**
+     * Handle the effects of the Counter Attack ability
+     *
+     * @param attacker The {@link LivingEntity} being affected by the ability
+     * @param damage The amount of damage initially dealt by the event
+     */
     public void counterAttackChecks(LivingEntity attacker, double damage) {
         if (Swords.counterAttackRequiresBlock && !getPlayer().isBlocking()) {
             return;
@@ -82,6 +88,12 @@ public class SwordsManager extends SkillManager {
         }
     }
 
+    /**
+     * Handle the effects of the Serrated Strikes ability
+     *
+     * @param target The {@link LivingEntity} being affected by the ability
+     * @param damage The amount of damage initially dealt by the event
+     */
     public void serratedStrikes(LivingEntity target, double damage) {
         CombatUtils.applyAbilityAoE(getPlayer(), target, damage / Swords.serratedStrikesModifier, skill);
         BleedTimerTask.add(target, Swords.serratedStrikesBleedTicks);

+ 1 - 0
src/main/java/com/gmail/nossr50/skills/taming/TamingManager.java

@@ -103,6 +103,7 @@ public class TamingManager extends SkillManager {
      *
      * @param target The LivingEntity to apply Gore on
      * @param damage The initial damage
+     * @param wolf The wolf using the ability
      */
     public void gore(LivingEntity target, double damage, Wolf wolf) {
         if (!SkillUtils.activationSuccessful(getSkillLevel(), getActivationChance(), Taming.goreMaxChance, Taming.goreMaxBonusLevel)) {

+ 7 - 2
src/main/java/com/gmail/nossr50/skills/unarmed/UnarmedManager.java

@@ -96,6 +96,12 @@ public class UnarmedManager extends SkillManager {
         return false;
     }
 
+    /**
+     * Handle the effects of the Berserk ability
+     *
+     * @param target The {@link LivingEntity} being affected by the ability
+     * @param damage The amount of damage initially dealt by the event
+     */
     public void berserkDamage(LivingEntity target, double damage) {
         damage = (damage * Unarmed.berserkDamageModifier) - damage;
 
@@ -105,8 +111,7 @@ public class UnarmedManager extends SkillManager {
     /**
      * Handle the effects of the Iron Arm ability
      *
-     * @param damage The amount of damage initially dealt by the event
-     * @return the modified event damage
+     * @param target The {@link LivingEntity} being affected by the ability
      */
     public void ironArm(LivingEntity target) {
         int unarmedBonus = Math.min(Unarmed.ironArmMinBonusDamage + (getSkillLevel() / Unarmed.ironArmIncreaseLevel), Unarmed.ironArmMaxBonusDamage);