Fix javadoc cutting off descriptions

Co-authored-by: Jordan Atwood <nightfirecat@protonmail.com>
This commit is contained in:
loldudester
2021-01-25 19:49:18 -08:00
committed by Jordan Atwood
parent f6c68eefc8
commit d68d66b01d
14 changed files with 24 additions and 24 deletions

View File

@@ -117,7 +117,7 @@ public enum ChatMessageType
*/
MODAUTOTYPER(91),
/**
* A game message (ie. when a setting is changed).
* A game message. (ie. when a setting is changed)
*/
CONSOLE(99),
/**

View File

@@ -433,7 +433,7 @@ public interface Client extends GameEngine
int getMouseCurrentButton();
/**
* Gets the currently selected tile (ie. last right clicked tile).
* Gets the currently selected tile. (ie. last right clicked tile)
*
* @return the selected tile
*/
@@ -1465,8 +1465,8 @@ public interface Client extends GameEngine
void setPlayersHidden(boolean state);
/**
* Sets whether 2D sprites (ie. overhead prayers, PK skull) related to
* the other players are hidden.
* Sets whether 2D sprites related to the other players are hidden.
* (ie. overhead prayers, PK skull)
*
* @param state the new player 2D hidden state
*/
@@ -1494,8 +1494,8 @@ public interface Client extends GameEngine
void setLocalPlayerHidden(boolean state);
/**
* Sets whether 2D sprites (ie. overhead prayers, PK skull) related to
* the local player are hidden.
* Sets whether 2D sprites related to the local player are hidden.
* (ie. overhead prayers, PK skull)
*
* @param state new local player 2D hidden state
*/
@@ -1509,8 +1509,8 @@ public interface Client extends GameEngine
void setNPCsHidden(boolean state);
/**
* Sets whether 2D sprites (ie. overhead prayers) related to
* the NPCs are hidden.
* Sets whether 2D sprites related to the NPCs are hidden.
* (ie. overhead prayers)
*
* @param state new NPC 2D hidden state
*/

View File

@@ -54,7 +54,7 @@ public enum HeadIcon
*/
REDEMPTION,
/**
* Protect from range and mage (ie. used by Kalphite Queen).
* Protect from range and mage. (ie. used by Kalphite Queen)
*/
RANGE_MAGE
}

View File

@@ -33,11 +33,11 @@ import lombok.Data;
public class MenuEntry
{
/**
* The option text added to the menu (ie. "Walk here", "Use").
* The option text added to the menu. (ie. "Walk here", "Use")
*/
private String option;
/**
* The target of the action (ie. Item or Actor name).
* The target of the action. (ie. Item or Actor name)
* <p>
* If the option does not apply to any target, this field
* will be set to empty string.

View File

@@ -58,7 +58,7 @@ public interface MessageNode extends Node
void setName(String name);
/**
* Gets the sender of the message (ie. friends chat name).
* Gets the sender of the message. (ie. friends chat name)
*
* @return the message sender
*/

View File

@@ -25,7 +25,7 @@
package net.runelite.api;
/**
* Represents a projectile entity (ie. cannonball, arrow).
* Represents a projectile entity. (ie. cannonball, arrow)
*/
public interface Projectile extends Renderable
{

View File

@@ -35,11 +35,11 @@ import lombok.Data;
public class MenuEntryAdded
{
/**
* The option text added to the menu (ie. "Walk here", "Use").
* The option text added to the menu. (ie. "Walk here", "Use")
*/
private final String option;
/**
* The target of the action (ie. Item or Actor name).
* The target of the action. (ie. Item or Actor name)
* <p>
* If the option does not apply to any target, this field
* will be set to empty string.

View File

@@ -27,7 +27,7 @@ package net.runelite.api.events;
import net.runelite.api.Client;
/**
* Posted when the game world the client wants to connect to has changed
* Posted when the game world the client wants to connect to has changed.
* This is posted after the world ID and type have updated, but before a new
* connection is established
*

View File

@@ -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;

View File

@@ -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;
/**

View File

@@ -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;

View File

@@ -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);
}

View File

@@ -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

View File

@@ -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.