summaryrefslogtreecommitdiffstats
path: root/src/main/java/org/bukkit/ChatColor.java
diff options
context:
space:
mode:
authorWesley Wolfe <weswolf@aol.com>2013-12-15 01:07:43 -0500
committerWesley Wolfe <weswolf@aol.com>2013-12-15 01:09:18 -0500
commitd8b48c2ec9f38a921ac54f5655a2da2d88f10ec5 (patch)
tree52ad0a3c379beb3fa5d8b0f368b0ade6649b8459 /src/main/java/org/bukkit/ChatColor.java
parent49a400e44a10dfdbccea86a1c76fb94ab2e666bf (diff)
downloadbukkit-d8b48c2ec9f38a921ac54f5655a2da2d88f10ec5.tar
bukkit-d8b48c2ec9f38a921ac54f5655a2da2d88f10ec5.tar.gz
bukkit-d8b48c2ec9f38a921ac54f5655a2da2d88f10ec5.tar.lz
bukkit-d8b48c2ec9f38a921ac54f5655a2da2d88f10ec5.tar.xz
bukkit-d8b48c2ec9f38a921ac54f5655a2da2d88f10ec5.zip
Pulling all pending Bukkit-JavaDoc changes
A special thanks goes to @aerouk for almost all of the changes found here.
Diffstat (limited to 'src/main/java/org/bukkit/ChatColor.java')
-rw-r--r--src/main/java/org/bukkit/ChatColor.java17
1 files changed, 10 insertions, 7 deletions
diff --git a/src/main/java/org/bukkit/ChatColor.java b/src/main/java/org/bukkit/ChatColor.java
index 6082c624..0bbc9fac 100644
--- a/src/main/java/org/bukkit/ChatColor.java
+++ b/src/main/java/org/bukkit/ChatColor.java
@@ -101,8 +101,8 @@ public enum ChatColor {
RESET('r', 0x15);
/**
- * The special character which prefixes all chat colour codes. Use this if you need to dynamically
- * convert colour codes from your custom format.
+ * The special character which prefixes all chat colour codes. Use this if
+ * you need to dynamically convert colour codes from your custom format.
*/
public static final char COLOR_CHAR = '\u00A7';
private static final Pattern STRIP_COLOR_PATTERN = Pattern.compile("(?i)" + String.valueOf(COLOR_CHAR) + "[0-9A-FK-OR]");
@@ -157,7 +157,8 @@ public enum ChatColor {
* Gets the color represented by the specified color code
*
* @param code Code to check
- * @return Associative {@link org.bukkit.ChatColor} with the given code, or null if it doesn't exist
+ * @return Associative {@link org.bukkit.ChatColor} with the given code,
+ * or null if it doesn't exist
*/
public static ChatColor getByChar(char code) {
return BY_CHAR.get(code);
@@ -167,7 +168,8 @@ public enum ChatColor {
* Gets the color represented by the specified color code
*
* @param code Code to check
- * @return Associative {@link org.bukkit.ChatColor} with the given code, or null if it doesn't exist
+ * @return Associative {@link org.bukkit.ChatColor} with the given code,
+ * or null if it doesn't exist
*/
public static ChatColor getByChar(String code) {
Validate.notNull(code, "Code cannot be null");
@@ -191,9 +193,10 @@ public enum ChatColor {
}
/**
- * Translates a string using an alternate color code character into a string that uses the internal
- * ChatColor.COLOR_CODE color code character. The alternate color code character will only be replaced
- * if it is immediately followed by 0-9, A-F, a-f, K-O, k-o, R or r.
+ * Translates a string using an alternate color code character into a
+ * string that uses the internal ChatColor.COLOR_CODE color code
+ * character. The alternate color code character will only be replaced if
+ * it is immediately followed by 0-9, A-F, a-f, K-O, k-o, R or r.
*
* @param altColorChar The alternate color code character to replace. Ex: &
* @param textToTranslate Text containing the alternate color code character.