Fixed javadoc comments.

alfonsoLeandro · Jan 18, 2021 · 47388c7 · 47388c7
1 parent 03a9df1
commit 47388c7
Showing 1 changed file with 4 additions and 1 deletion.
diff --git a/src/main/java/com/github/alfonsoleandro/mputils/time/Cooldown.java b/src/main/java/com/github/alfonsoleandro/mputils/time/Cooldown.java
@@ -46,6 +46,9 @@ public class Cooldown {
      * Creates a cooldown object.
      * When creating a new cooldown the HashMap is also new so players in another cooldown do not
      * have nothing to do with the new cooldown.
+     *
+     * @param cooldownName The name to be given to this cooldown, used for saving to the cooldown file.
+     *                     Suggested cooldownName is "PluginName-CooldownType", i.e: "MPUtils-SendMessage"
      */
     public Cooldown(String cooldownName){
         this.cooldownName = cooldownName;
@@ -78,7 +81,7 @@ public void removeFromCooldown(String playerName){
 
     /**
      * Checks if a player is on cooldown.
-     * This method will be removed from MPUtils. Please use "{@link #getTimeLeft(String)} > 0" instead for
+     * This method will be removed from MPUtils. Please use "{@link #getTimeLeft(String)} {@literal >} 0" instead for
      * checking if a player is on cooldown.
      *
      * @param playerName The player to look for.