Fix javadoc cutting off descriptions
Co-authored-by: Jordan Atwood <nightfirecat@protonmail.com>
This commit is contained in:
committed by
Jordan Atwood
parent
f6c68eefc8
commit
d68d66b01d
@@ -237,7 +237,7 @@ public enum AgilityShortcut
|
||||
@Getter
|
||||
private final int level;
|
||||
/**
|
||||
* Brief description of the shortcut (e.g. 'Rocks', 'Stepping Stones', 'Jump')
|
||||
* Brief description of the shortcut. (e.g. 'Rocks', 'Stepping Stones', 'Jump')
|
||||
*/
|
||||
@Getter
|
||||
private final String description;
|
||||
|
||||
@@ -33,11 +33,11 @@ import net.runelite.client.util.ColorUtil;
|
||||
public final class WidgetMenuOption
|
||||
{
|
||||
/**
|
||||
* The left hand text to be displayed on the menu option. Ex. the menuOption of "Drop Bones" is "Drop"
|
||||
* The left hand text to be displayed on the menu option. (ex. the menuOption of "Drop Bones" is "Drop")
|
||||
*/
|
||||
private String menuOption;
|
||||
/**
|
||||
* The right hand text to be displayed on the menu option Ex. the menuTarget of "Drop Bones" is "Bones"
|
||||
* The right hand text to be displayed on the menu option. (ex. the menuTarget of "Drop Bones" is "Bones")
|
||||
*/
|
||||
private String menuTarget;
|
||||
/**
|
||||
|
||||
@@ -470,7 +470,7 @@ enum DiscordGameEventType
|
||||
private int priority;
|
||||
|
||||
/**
|
||||
* Marks this event as root event, e.g event that should be used for total time tracking
|
||||
* Marks this event as root event. (eg. event that should be used for total time tracking)
|
||||
*/
|
||||
private boolean root;
|
||||
|
||||
|
||||
@@ -52,7 +52,7 @@ public abstract class Stat
|
||||
public abstract int getValue(Client client);
|
||||
|
||||
/**
|
||||
* Get the base stat maximum, ie. the bottom half of the stat fraction.
|
||||
* Get the base stat maximum. (ie. the bottom half of the stat fraction)
|
||||
*/
|
||||
public abstract int getMaximum(Client client);
|
||||
}
|
||||
|
||||
@@ -159,8 +159,8 @@ class XpState
|
||||
}
|
||||
|
||||
/**
|
||||
* Update number of actions performed for skill (e.g amount of kills in this case) if last interacted
|
||||
* NPC died
|
||||
* Update number of actions performed for skill if last interacted NPC died.
|
||||
* (eg. amount of kills in this case)
|
||||
* @param skill skill to update actions for
|
||||
* @param npc npc that just died
|
||||
* @param npcHealth max health of npc that just died
|
||||
|
||||
@@ -182,7 +182,7 @@ public class QuantityFormatter
|
||||
}
|
||||
|
||||
/**
|
||||
* Calculates, given a string with a value denominator (ex. 20K)
|
||||
* Calculates, given a string with a value denominator (for example, 20K)
|
||||
* the multiplier that the denominator represents (in this case 1000).
|
||||
*
|
||||
* @param string The string to check.
|
||||
|
||||
Reference in New Issue
Block a user