Skip to content

Commit a9d7cb3

Browse files
committed
[Docs] Update some JavaDoc references.
1 parent 8aa59ca commit a9d7cb3

3 files changed

Lines changed: 10 additions & 20 deletions

File tree

src/main/java/ca/q0r/mchat/api/Parser.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ public class Parser {
2222
/**
2323
* Core Formatting
2424
*
25-
* @param uuid Name of Player being reflected upon.
25+
* @param uuid UUID of Player being reflected upon.
2626
* @param world Player's World.
2727
* @param msg Message being displayed.
2828
* @param format Resulting Format.

src/main/java/ca/q0r/mchat/api/Reader.java

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ public class Reader {
3030
/**
3131
* Raw Info Resolving
3232
*
33-
* @param uuid Defining value of the InfoType(Also known as Name).
33+
* @param uuid Defining value of the InfoType (Also known as name/uuid).
3434
* @param world Name of the InfoType's World.
3535
* @param type InfoType being reflected upon.
3636
* @param info Info Variable being resolved.
@@ -75,7 +75,7 @@ public static String getRawInfo(UUID uuid, InfoType type, String world, String i
7575
/**
7676
* Raw Prefix Resolving
7777
*
78-
* @param uuid Defining value of the InfoType(Also known as Name).
78+
* @param uuid Defining value of the InfoType (Also known as name/uuid).
7979
* @param type InfoType being reflected upon.
8080
* @param world Name of the InfoType's World.
8181
* @return Raw Prefix.
@@ -87,7 +87,7 @@ public static String getRawPrefix(UUID uuid, InfoType type, String world) {
8787
/**
8888
* Raw Suffix Resolving
8989
*
90-
* @param uuid Defining value of the InfoType(Also known as Name).
90+
* @param uuid Defining value of the InfoType (Also known as name/uuid).
9191
* @param type InfoType being reflected upon.
9292
* @param world Name of the InfoType's World.
9393
* @return Raw Suffix.
@@ -99,7 +99,7 @@ public static String getRawSuffix(UUID uuid, InfoType type, String world) {
9999
/**
100100
* Raw Group Resolving
101101
*
102-
* @param uuid Defining value of the InfoType(Also known as Name).
102+
* @param uuid Defining value of the InfoType (Also known as name/uuid).
103103
* @param type InfoType being reflected upon.
104104
* @param world Name of the InfoType's World.
105105
* @return Raw Group.
@@ -111,7 +111,7 @@ public static String getRawGroup(UUID uuid, InfoType type, String world) {
111111
/**
112112
* Raw Info Resolving
113113
*
114-
* @param uuid Defining value of the InfoType(Also known as Name).
114+
* @param uuid Defining value of the InfoType (Also known as name/uuid).
115115
* @param type InfoType being reflected upon.
116116
* @param world Player's World.
117117
* @param info Info Variable being resolved.
@@ -124,7 +124,7 @@ public static String getInfo(UUID uuid, InfoType type, String world, String info
124124
/**
125125
* Formatted Prefix Resolving
126126
*
127-
* @param uuid Defining value of the InfoType(Also known as Name).
127+
* @param uuid Defining value of the InfoType (Also known as name/uuid).
128128
* @param type InfoType being reflected upon.
129129
* @param world Name of the InfoType's World.
130130
* @return Formatted Prefix.
@@ -136,7 +136,7 @@ public static String getPrefix(UUID uuid, InfoType type, String world) {
136136
/**
137137
* Formatted Suffix Resolving
138138
*
139-
* @param uuid Defining value of the InfoType(Also known as Name).
139+
* @param uuid Defining value of the InfoType (Also known as name/uuid).
140140
* @param type InfoType being reflected upon.
141141
* @param world Name of the InfoType's World.
142142
* @return Formatted Suffix.
@@ -148,7 +148,7 @@ public static String getSuffix(UUID uuid, InfoType type, String world) {
148148
/**
149149
* Formatted Group Resolving
150150
*
151-
* @param uuid Defining value of the InfoType(Also known as Name).
151+
* @param uuid Defining value of the InfoType (Also known as name/uuid).
152152
* @param world Name of the InfoType's World.
153153
* @return Formatted Group.
154154
*/
@@ -518,7 +518,7 @@ public static String getWorldName(String world) {
518518
/**
519519
* Player Name Resolver
520520
*
521-
* @param uuid Name of Player to be Resolved.
521+
* @param uuid UUID of Player to be Resolved.
522522
* @return Player Name's MChat Alias.
523523
*/
524524
public static String getMName(UUID uuid) {

src/main/java/ca/q0r/mchat/types/InfoType.java

Lines changed: 0 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -27,14 +27,4 @@ private InfoType(String name) {
2727
public String getConfValue() {
2828
return name;
2929
}
30-
31-
/*public static InfoType fromName(String name) {
32-
for (InfoType type : InfoType.values()) {
33-
if (type.name.contains(name)) {
34-
return type;
35-
}
36-
}
37-
38-
return null;
39-
}*/
4030
}

0 commit comments

Comments
 (0)