more documentation changes

Author: vytskalt

api/src/main/java/net/megavex/scoreboardlibrary/api/ScoreboardLibrary.java

@@ -17,15 +17,15 @@
 
 /**
  * Entrypoint of the library. To create an instance of this interface, use {@link #loadScoreboardLibrary}.
- * For unit tests, take a look at {@link NoopScoreboardLibrary}.
+ * For unit testing, take a look at {@link NoopScoreboardLibrary}.
  * Note: this class is thread-safe, meaning you can safely use it from multiple threads at a time.
  */
 @ApiStatus.NonExtendable
 public interface ScoreboardLibrary {
   /**
    * Creates an instance of {@link ScoreboardLibrary}.
    *
-   * @param plugin Your plugin instance
+   * @param plugin your plugin instance
    * @throws NoPacketAdapterAvailableException if there is no packet adapter available for the current server version
    */
   static @NotNull ScoreboardLibrary loadScoreboardLibrary(@NotNull Plugin plugin) throws NoPacketAdapterAvailableException {
@@ -53,7 +53,7 @@ public interface ScoreboardLibrary {
   /**
    * Creates a new {@link Sidebar};
    *
-   * @return Newly created sidebar
+   * @return newly created sidebar
    */
   default @NotNull Sidebar createSidebar() {
     return createSidebar(Sidebar.MAX_LINES, null);
@@ -62,9 +62,9 @@ public interface ScoreboardLibrary {
   /**
    * Creates a new {@link Sidebar}.
    *
-   * @param maxLines Max amount of lines the sidebar will have.
+   * @param maxLines max amount of lines the sidebar will have.
    *                 Note that vanilla clients can only display at most {@value Sidebar#MAX_LINES}
-   * @return Newly created sidebar
+   * @return newly created sidebar
    */
   default @NotNull Sidebar createSidebar(@Range(from = 1, to = Integer.MAX_VALUE) int maxLines) {
     return createSidebar(maxLines, null);
@@ -73,25 +73,25 @@ public interface ScoreboardLibrary {
   /**
    * Creates a new {@link Sidebar}.
    *
-   * @param maxLines Max amount of lines the sidebar will have.
+   * @param maxLines max amount of lines the sidebar will have.
    *                 Note that vanilla clients can only display at most {@value Sidebar#MAX_LINES}
-   * @param locale   Locale which will be used for translating {@link net.kyori.adventure.text.TranslatableComponent}s,
+   * @param locale   locale which will be used for translating {@link net.kyori.adventure.text.TranslatableComponent}s,
    *                 or null if the locale should depend on the player
-   * @return Newly created sidebar
+   * @return newly created sidebar
    */
   @NotNull Sidebar createSidebar(@Range(from = 1, to = Integer.MAX_VALUE) int maxLines, @Nullable Locale locale);
 
   /**
    * Creates a new {@link TeamManager}.
    *
-   * @return Newly created team manager
+   * @return newly created team manager
    */
   @NotNull TeamManager createTeamManager();
 
   /**
    * Creates a new {@link ObjectiveManager}.
    *
-   * @return Newly created objective manager
+   * @return newly created objective manager
    */
   @NotNull ObjectiveManager createObjectiveManager();
 
@@ -102,7 +102,7 @@ public interface ScoreboardLibrary {
   void close();
 
   /**
-   * @return Whether this scoreboard library instance is closed
+   * @return whether this scoreboard library instance is closed
    */
   boolean closed();
 }

api/src/main/java/net/megavex/scoreboardlibrary/api/objective/ObjectiveManager.java

@@ -16,28 +16,28 @@ public interface ObjectiveManager {
   /**
    * Creates an objective with a name if one doesn't already exist and returns it.
    *
-   * @param name Name of the objective
-   * @return Objective
+   * @param name name of the objective
+   * @return objective
    */
   @NotNull ScoreboardObjective create(@NotNull String name);
 
   /**
    * Removes an objective.
    *
-   * @param objective Objective to remove
+   * @param objective objective to remove
    */
   void remove(@NotNull ScoreboardObjective objective);
 
   /**
    * Updates which objective is shown in a display slot.
    *
-   * @param displaySlot Display slot value to show objective in
-   * @param objective   Objective to display in that display slot
+   * @param displaySlot display slot value to show objective in
+   * @param objective   objective to display in that display slot
    */
   void display(@NotNull ObjectiveDisplaySlot displaySlot, @NotNull ScoreboardObjective objective);
 
   /**
-   * @return Unmodifiable collection of viewers in this ObjectiveManager
+   * @return unmodifiable collection of viewers in this ObjectiveManager
    * @see #addPlayer
    * @see #removePlayer
    */
@@ -49,15 +49,15 @@ public interface ObjectiveManager {
    * The ObjectiveManager will internally be added to a queue for this player who
    * will start seeing it once they are removed from all previous ObjectiveManagers.
    *
-   * @param player Player to add
-   * @return Whether the player was added
+   * @param player player to add
+   * @return whether the player was added
    */
   boolean addPlayer(@NotNull Player player);
 
   /**
    * Adds multiple viewers to this ObjectiveManager.
    *
-   * @param players Viewers to add
+   * @param players viewers to add
    * @see #addPlayer
    */
   default void addPlayers(@NotNull Collection<Player> players) {
@@ -69,15 +69,15 @@ default void addPlayers(@NotNull Collection<Player> players) {
   /**
    * Removes a viewer from this ObjectiveManager.
    *
-   * @param player Viewer to remove
-   * @return Whether the viewer was removed
+   * @param player viewer to remove
+   * @return whether the viewer was removed
    */
   boolean removePlayer(@NotNull Player player);
 
   /**
    * Removes multiple viewers from this ObjectiveManager
    *
-   * @param players Viewers to remove
+   * @param players viewers to remove
    */
   default void removePlayers(@NotNull Collection<Player> players) {
     for (Player player : players) {
@@ -92,7 +92,7 @@ default void removePlayers(@NotNull Collection<Player> players) {
   void close();
 
   /**
-   * @return Whether this ObjectiveManager is closed
+   * @return whether this ObjectiveManager is closed
    * @see #close
    */
   boolean closed();

api/src/main/java/net/megavex/scoreboardlibrary/api/objective/ScoreboardObjective.java

@@ -13,26 +13,26 @@
  */
 public interface ScoreboardObjective {
   /**
-   * @return The value (display name) of the objective, defaults to {@link Component#empty}
+   * @return the value (display name) of the objective, defaults to {@link Component#empty}
    */
   @NotNull Component value();
 
   /**
    * Sets the value (display name) of the objective.
    *
-   * @param value New value
+   * @param value new value
    */
   @NotNull ScoreboardObjective value(@NotNull ComponentLike value);
 
   /**
-   * @return The render type of the objective, defaults to {@link ObjectiveRenderType#INTEGER}
+   * @return the render type of the objective, defaults to {@link ObjectiveRenderType#INTEGER}
    */
   @NotNull ObjectiveRenderType renderType();
 
   /**
    * Sets the render type of the objective.
    *
-   * @param renderType New render type
+   * @param renderType new render type
    */
   @NotNull ScoreboardObjective renderType(@NotNull ObjectiveRenderType renderType);
 
@@ -52,16 +52,16 @@ public interface ScoreboardObjective {
   /**
    * Get the score for an entry, or null if the entry has no score.
    *
-   * @param entry Entry to get score of
-   * @return The score value, or null if it doesn't exist for the entry
+   * @param entry entry to get score of
+   * @return the score value, or null if it doesn't exist for the entry
    */
   @Nullable ObjectiveScore scoreInfo(@NotNull String entry);
 
   /**
    * Gets the score value for an entry, or null if the entry has no score.
    *
-   * @param entry Entry to get score of
-   * @return The score value, or null if it doesn't exist for the entry
+   * @param entry entry to get score of
+   * @return the score value, or null if it doesn't exist for the entry
    * @deprecated use {@link #scoreInfo(String).value()} and {@link ObjectiveScore#value()} instead
    */
   @Deprecated
@@ -73,16 +73,16 @@ public interface ScoreboardObjective {
   /**
    * Updates the score of an entry.
    *
-   * @param entry Entry to update score of
-   * @param score Score
+   * @param entry entry to update score of
+   * @param score score
    */
   @NotNull ScoreboardObjective score(@NotNull String entry, ObjectiveScore score);
 
   /**
    * Updates the score of an entry.
    *
-   * @param entry Entry to update score of
-   * @param scoreValue Score value
+   * @param entry entry to update score of
+   * @param scoreValue score value
    */
   default @NotNull ScoreboardObjective score(@NotNull String entry, int scoreValue) {
     return score(entry, new ObjectiveScore(scoreValue, null, null));
@@ -138,7 +138,7 @@ public interface ScoreboardObjective {
   /**
    * Removes a score associated with an entry.
    *
-   * @param entry Entry to remove score of
+   * @param entry entry to remove score of
    */
   @NotNull ScoreboardObjective removeScore(@NotNull String entry);
 }

api/src/main/java/net/megavex/scoreboardlibrary/api/sidebar/Sidebar.java

@@ -29,12 +29,12 @@ public interface Sidebar {
   // Main
 
   /**
-   * @return Max amount of lines this sidebar can have
+   * @return max amount of lines this sidebar can have
    */
   @Range(from = 1, to = Integer.MAX_VALUE) int maxLines();
 
   /**
-   * @return Locale which is used for translating {@link net.kyori.adventure.text.TranslatableComponent}s,
+   * @return locale which is used for translating {@link net.kyori.adventure.text.TranslatableComponent}s,
    * or null if it depends on each player's client locale.
    * @see ScoreboardLibrary#createSidebar(int, Locale)
    */
@@ -45,16 +45,16 @@ public interface Sidebar {
   /**
    * Gets a line's value.
    *
-   * @param line Line index
-   * @return Value of line, or null if unset
+   * @param line line index
+   * @return value of line, or null if unset
    */
   @Nullable Component line(@Range(from = 0, to = Integer.MAX_VALUE - 1) int line);
 
   /**
    * Sets a line's value.
    *
-   * @param index Line index
-   * @param value New value, or null to hide
+   * @param index line index
+   * @param value new value, or null to hide
    */
   default void line(@Range(from = 0, to = Integer.MAX_VALUE - 1) int index, @Nullable ComponentLike value) {
     line(index, value, null);
@@ -64,9 +64,9 @@ default void line(@Range(from = 0, to = Integer.MAX_VALUE - 1) int index, @Nulla
    * Sets a line's value with a custom score format.
    * Note that custom score formats are only supported in Minecraft 1.20.3+.
    *
-   * @param index       Line index
-   * @param value       New value, or null to hide
-   * @param scoreFormat Score format
+   * @param index       line index
+   * @param value       new value, or null to hide
+   * @param scoreFormat score format
    */
   void line(
     @Range(from = 0, to = Integer.MAX_VALUE - 1) int index,
@@ -86,21 +86,21 @@ default void clearLines() {
   // Title
 
   /**
-   * @return Title of the sidebar, defaults to {@link Component#empty}
+   * @return title of the sidebar, defaults to {@link Component#empty}
    */
   @NotNull Component title();
 
   /**
    * Sets the title of the sidebar.
    *
-   * @param title Title
+   * @param title title
    */
   void title(@NotNull ComponentLike title);
 
   // Players
 
   /**
-   * @return Unmodifiable collection of viewers in this Sidebar
+   * @return unmodifiable collection of viewers in this Sidebar
    * @see #addPlayer
    * @see #removePlayer
    */
@@ -112,15 +112,15 @@ default void clearLines() {
    * The Sidebar will internally be added to a queue for this player who
    * will start seeing it once they are removed from all previous Sidebars.
    *
-   * @param player Player to add
-   * @return Whether the player was added
+   * @param player player to add
+   * @return whether the player was added
    */
   boolean addPlayer(@NotNull Player player);
 
   /**
    * Adds multiple viewers to this Sidebar.
    *
-   * @param players Viewers to add
+   * @param players viewers to add
    * @see #addPlayer
    */
   default void addPlayers(@NotNull Collection<Player> players) {
@@ -132,15 +132,15 @@ default void addPlayers(@NotNull Collection<Player> players) {
   /**
    * Removes a viewer from this Sidebar.
    *
-   * @param player Viewer to remove
-   * @return Whether the viewer was removed
+   * @param player viewer to remove
+   * @return whether the viewer was removed
    */
   boolean removePlayer(@NotNull Player player);
 
   /**
    * Removes multiple viewers from this Sidebar
    *
-   * @param players Viewers to remove
+   * @param players viewers to remove
    */
   default void removePlayers(@NotNull Collection<Player> players) {
     for (Player player : players) {

api/src/main/java/net/megavex/scoreboardlibrary/api/sidebar/component/ComponentSidebarLayout.java

@@ -10,6 +10,9 @@
 
 import static net.kyori.adventure.text.Component.empty;
 
+/**
+ * Represents a component sidebar layout that can be applied to a {@link Sidebar}.
+ */
 public final class ComponentSidebarLayout {
   private final SidebarComponent titleComponent;
   private final SidebarComponent linesComponent;

api/src/main/java/net/megavex/scoreboardlibrary/api/sidebar/component/animation/CollectionSidebarAnimation.java

@@ -8,6 +8,11 @@
 import java.util.Collection;
 import java.util.List;
 
+/**
+ * Implementation of {@link FramedSidebarAnimation} using a predefined collection of frames.
+ *
+ * @param <T> frame type
+ */
 public final class CollectionSidebarAnimation<T> implements FramedSidebarAnimation<T> {
   private final List<T> frames;
   private int currentFrameIndex;