Skip to content

Commit 5981ef9

Browse files
committed
Fixed the javadocs.
1 parent 08a4298 commit 5981ef9

File tree

8 files changed

+17
-18
lines changed

8 files changed

+17
-18
lines changed

src/main/java/me/tom/sparse/spigot/chat/menu/ChatMenuAPI.java

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ public final class ChatMenuAPI
2525
private ChatMenuAPI() {}
2626

2727
/**
28-
* @param player the player whose getCurrent menu should be returned
28+
* @param player the player whose current menu should be returned
2929
* @return the menu the player currently has open, or {@code null} if no menu is open.
3030
*/
3131
@Nullable
@@ -35,11 +35,10 @@ public static ChatMenu getCurrentMenu(@Nonnull Player player)
3535
}
3636

3737
/**
38-
* @param player the player whose getCurrent menu should be setCurrent
39-
* @param menu the menu to setCurrent as getCurrent, or {@code null} if you want to close the getCurrent menu.
38+
* @param player the player whose current menu should be returned
39+
* @param menu the menu to set as current, or {@code null} if you want to close the current menu.
4040
*/
41-
@Nullable
42-
public static void setCurrentMenu(@Nonnull Player player, @Nonnull ChatMenu menu)
41+
public static void setCurrentMenu(@Nonnull Player player, @Nullable ChatMenu menu)
4342
{
4443
ChatMenu old = OPENED_MENUS.remove(player);
4544
if(old != null && old != menu) old.onClosed(player);
@@ -73,7 +72,7 @@ private static String generateIdentifier()
7372
}
7473

7574
/**
76-
* Gets the getCurrent {@link PlayerChatIntercept} associated with the provided player.
75+
* Gets the current {@link PlayerChatIntercept} associated with the provided player.
7776
* If the player does not have one, it will be created.
7877
*
7978
* @param player the player to get/create the {@link PlayerChatIntercept} for

src/main/java/me/tom/sparse/spigot/chat/menu/element/BooleanElement.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -147,7 +147,7 @@ public void edit(@Nonnull IElementContainer container, @Nonnull String[] args)
147147
}
148148

149149
/**
150-
* @return the getCurrent value
150+
* @return the current value
151151
*/
152152
@Nonnull
153153
public boolean getValue()

src/main/java/me/tom/sparse/spigot/chat/menu/element/Element.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -211,7 +211,7 @@ public final boolean overlaps(@Nonnull Element other)
211211
}
212212

213213
/**
214-
* @param context the getCurrent render context
214+
* @param context the current render context
215215
* @return the rendered text
216216
*/
217217
public abstract List<Text> render(IElementContainer context);

src/main/java/me/tom/sparse/spigot/chat/menu/element/IncrementalElement.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,7 @@ public void setValue(int value)
100100
}
101101

102102
/**
103-
* @return the getCurrent value
103+
* @return the current value
104104
*/
105105
public int getValue()
106106
{

src/main/java/me/tom/sparse/spigot/chat/menu/element/InputElement.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ public InputElement(int x, int y, int width, @Nonnull String value)
3838
}
3939

4040
/**
41-
* @return the getCurrent value
41+
* @return the current value
4242
*/
4343
@Nullable
4444
public String getValue()

src/main/java/me/tom/sparse/spigot/chat/menu/element/NumberSliderElement.java

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,7 @@ public NumberSliderElement numberFormat(@Nullable NumberFormat format)
111111
}
112112

113113
/**
114-
* @return the getCurrent number format
114+
* @return the current number format
115115
*/
116116
@Nonnull
117117
public NumberFormat getNumberFormat()
@@ -213,7 +213,7 @@ public void setLength(int length)
213213
}
214214

215215
/**
216-
* Sets the length of this (based on the getCurrent precision) to attempt to make the width match as closely as possible to the target width.
216+
* Sets the length of this (based on the current precision) to attempt to make the width match as closely as possible to the target width.
217217
*
218218
* @param width the width to attempt to match
219219
*/
@@ -224,7 +224,7 @@ public void setWidth(int width)
224224
}
225225

226226
/**
227-
* Sets the length of this (based on the getCurrent precision) to attempt to make the width match as closely as possible to the target width.
227+
* Sets the length of this (based on the current precision) to attempt to make the width match as closely as possible to the target width.
228228
*
229229
* @param width the width to attempt to match
230230
* @return this
@@ -237,7 +237,7 @@ public NumberSliderElement width(int width)
237237
}
238238

239239
/**
240-
* @return the getCurrent value
240+
* @return the current value
241241
*/
242242
public int getValue()
243243
{
@@ -253,7 +253,7 @@ public void setValue(int value)
253253
}
254254

255255
/**
256-
* @return the bar character used based on the getCurrent precision
256+
* @return the bar character used based on the current precision
257257
*/
258258
public char getCharacter()
259259
{

src/main/java/me/tom/sparse/spigot/chat/menu/element/TextElement.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -134,7 +134,7 @@ public TextElement align(@Nonnull TextAlignment alignment)
134134
}
135135

136136
/**
137-
* @return the getCurrent text alignment
137+
* @return the current text alignment
138138
*/
139139
@Nonnull
140140
public TextAlignment getAlignment()

src/main/java/me/tom/sparse/spigot/chat/util/State.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ public State(@Nonnull V current)
4242
}
4343

4444
/**
45-
* Sets the getCurrent value if the provided value is not {@link Object#equals} to the old one, then calls the {@code changeCallback}.
45+
* Sets the current value if the provided value is not {@link Object#equals} to the old one, then calls the {@code changeCallback}.
4646
*
4747
* @param newValue the new value
4848
*/
@@ -61,7 +61,7 @@ public void setCurrent(@Nonnull V newValue)
6161
}
6262

6363
/**
64-
* @return the getCurrent value. Might be {@code null}.
64+
* @return the current value. Might be {@code null}.
6565
*/
6666
@Nullable
6767
public V getCurrent()

0 commit comments

Comments
 (0)