Fix a couple of typos in the javadoc for Player (#5235)

This commit is contained in:
Jason Penilla
2021-02-23 05:46:02 -08:00
parent 9cf511130f
commit 84af0796d3

View File

@@ -919,9 +919,9 @@ index 0000000000000000000000000000000000000000..00000000000000000000000000000000
+ void playerListName(@Nullable net.kyori.adventure.text.Component name); + void playerListName(@Nullable net.kyori.adventure.text.Component name);
+ +
+ /** + /**
+ * Gets the currently displayed player list header for this player. + * Gets the name that is shown on the in-game player list.
+ * + *
+ * @return player list header or null + * @return the player list name
+ */ + */
+ @Nullable net.kyori.adventure.text.Component playerListName(); + @Nullable net.kyori.adventure.text.Component playerListName();
+ +
@@ -929,14 +929,13 @@ index 0000000000000000000000000000000000000000..00000000000000000000000000000000
+ * Gets the currently displayed player list header for this player. + * Gets the currently displayed player list header for this player.
+ * + *
+ * @return player list header or null + * @return player list header or null
+ * @deprecated in favour of {@link #playerListName()}
+ */ + */
+ @Nullable net.kyori.adventure.text.Component playerListHeader(); + @Nullable net.kyori.adventure.text.Component playerListHeader();
+ +
+ /** + /**
+ * Gets the currently displayed player list footer for this player. + * Gets the currently displayed player list footer for this player.
+ * + *
+ * @return player list header or null + * @return player list footer or null
+ */ + */
+ @Nullable net.kyori.adventure.text.Component playerListFooter(); + @Nullable net.kyori.adventure.text.Component playerListFooter();
+ // Paper end + // Paper end