From deeaa0693030c67bdb475912bce6a50b060990f2 Mon Sep 17 00:00:00 2001 From: Parker Hawke Date: Sun, 31 May 2020 11:03:07 -0400 Subject: [PATCH] Resolve all Javadoc warnings --- .gitignore | 3 ++- src/main/java/com/ninjaguild/dragoneggdrop/DragonEggDrop.java | 2 ++ .../com/ninjaguild/dragoneggdrop/dragon/DamageHistory.java | 4 ++-- .../dragon/loot/elements/DragonLootElementEgg.java | 4 ++-- 4 files changed, 8 insertions(+), 5 deletions(-) diff --git a/.gitignore b/.gitignore index 140529d..a52988e 100644 --- a/.gitignore +++ b/.gitignore @@ -5,6 +5,7 @@ .metadata bin/ tmp/ +doc/ *.tmp *.bak *.swp @@ -211,4 +212,4 @@ gradle-app.setting # gradle/wrapper/gradle-wrapper.properties ### Gradle Patch ### -**/build/ \ No newline at end of file +**/build/ diff --git a/src/main/java/com/ninjaguild/dragoneggdrop/DragonEggDrop.java b/src/main/java/com/ninjaguild/dragoneggdrop/DragonEggDrop.java index 00f5b2b..dae5335 100644 --- a/src/main/java/com/ninjaguild/dragoneggdrop/DragonEggDrop.java +++ b/src/main/java/com/ninjaguild/dragoneggdrop/DragonEggDrop.java @@ -187,6 +187,8 @@ public static DragonEggDrop getInstance() { * * @param sender the sender to which the message should be sent * @param message the message to send + * + * @param command sender type */ public static void sendMessage(T sender, String message) { sender.sendMessage(CHAT_PREFIX + message); diff --git a/src/main/java/com/ninjaguild/dragoneggdrop/dragon/DamageHistory.java b/src/main/java/com/ninjaguild/dragoneggdrop/dragon/DamageHistory.java index 0a25fbf..cdc64cc 100644 --- a/src/main/java/com/ninjaguild/dragoneggdrop/dragon/DamageHistory.java +++ b/src/main/java/com/ninjaguild/dragoneggdrop/dragon/DamageHistory.java @@ -99,7 +99,7 @@ public DamageEntry getTopDamager() { * If offset of 2, third most. So on and so forth. Offset 0 would be equivalent to * {@link #getTopDamager()}. * - * @param offset the damage entry offset. Must be < {@link #uniqueDamagers()} + * @param offset the damage entry offset. Must be {@literal <} {@link #uniqueDamagers()} * * @return the top damager at the given offset */ @@ -182,7 +182,7 @@ public DamageEntry getMostRecentDamage() { * offset of 2, third most. So on and so forth. Offset 0 would be equivalent to * {@link #getMostRecentDamage()}. * - * @param offset the damage entry offset. Must be < {@link #size()} + * @param offset the damage entry offset. Must be {@literal <} {@link #size()} * * @return the damage entry at the given offset */ diff --git a/src/main/java/com/ninjaguild/dragoneggdrop/dragon/loot/elements/DragonLootElementEgg.java b/src/main/java/com/ninjaguild/dragoneggdrop/dragon/loot/elements/DragonLootElementEgg.java index 8dae40e..c7d629a 100644 --- a/src/main/java/com/ninjaguild/dragoneggdrop/dragon/loot/elements/DragonLootElementEgg.java +++ b/src/main/java/com/ninjaguild/dragoneggdrop/dragon/loot/elements/DragonLootElementEgg.java @@ -111,8 +111,8 @@ public boolean isCentered() { /** * {@inheritDoc} - * - * @implNote Hardcoded to 0.0. Eggs are not meant to be generated by loot pools + *

+ * NOTE: Hardcoded to 0.0. Eggs are not meant to be generated by loot pools */ @Override public double getWeight() {