Version 3.0.1

TriumphTeam · Jun 13, 2021 · c7f6c76 · c7f6c76
1 parent 50de884
commit c7f6c76
Show file tree

Hide file tree

Showing 5 changed files with 17 additions and 31 deletions.
diff --git a/build.gradle.kts b/build.gradle.kts
@@ -11,7 +11,7 @@ subprojects {
  }
 
  group = "dev.triumphteam"
- version = "3.0.0"
+ version = "3.0.1"
 
  repositories {
  mavenCentral()

diff --git a/core/src/main/java/dev/triumphteam/gui/builder/item/BookBuilder.java b/core/src/main/java/dev/triumphteam/gui/builder/item/BookBuilder.java
@@ -15,7 +15,7 @@
 import java.util.List;
 
 /**
- * Item builder for {@link Material#WRITTEN_BOOK} & {@link Material#WRITTEN_BOOK} only
+ * Item builder for {@link Material#WRITTEN_BOOK} and {@link Material#WRITTEN_BOOK} only
  *
  * @author GabyTM <a href="https://github.com/iGabyTM">https://github.com/iGabyTM</a>
  * @since 3.0.1

diff --git a/core/src/main/java/dev/triumphteam/gui/builder/item/FireworkBuilder.java b/core/src/main/java/dev/triumphteam/gui/builder/item/FireworkBuilder.java
@@ -12,7 +12,7 @@
 import java.util.List;
 
 /**
- * Item builder for {@link Material#FIREWORK_ROCKET} & {@link Material#FIREWORK_ROCKET} only
+ * Item builder for {@link Material#FIREWORK_ROCKET} and {@link Material#FIREWORK_ROCKET} only
  *
  * @author GabyTM <a href="https://github.com/iGabyTM">https://github.com/iGabyTM</a>
  * @since 3.0.1

diff --git a/core/src/main/java/dev/triumphteam/gui/guis/BaseGui.java b/core/src/main/java/dev/triumphteam/gui/guis/BaseGui.java
@@ -1,18 +1,18 @@
 /**
  * MIT License
- *
+ * <p>
  * Copyright (c) 2021 TriumphTeam
- *
+ * <p>
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal
  * in the Software without restriction, including without limitation the rights
  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  * copies of the Software, and to permit persons to whom the Software is
  * furnished to do so, subject to the following conditions:
- *
+ * <p>
  * The above copyright notice and this permission notice shall be included in all
  * copies or substantial portions of the Software.
- *
+ * <p>
  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
@@ -118,6 +118,7 @@ public abstract class BaseGui implements InventoryHolder {
  *
  * @param rows The amount of rows to use.
  * @param title The GUI title using {@link Component}.
+ * @param interactionModifiers Modifiers to select which interactions are allowed.
  * @since 3.0.0.
  */
  public BaseGui(final int rows, @NotNull final Component title, @NotNull final Set<InteractionModifier> interactionModifiers) {
@@ -134,6 +135,7 @@ public BaseGui(final int rows, @NotNull final Component title, @NotNull final Se
  *
  * @param guiType The {@link GuiType} to use.
  * @param title The GUI title using {@link Component}.
+ * @param interactionModifiers Modifiers to select which interactions are allowed.
  * @since 3.0.0
  */
  public BaseGui(@NotNull final GuiType guiType, @NotNull final Component title, @NotNull final Set<InteractionModifier> interactionModifiers) {

diff --git a/core/src/main/java/dev/triumphteam/gui/guis/PaginatedGui.java b/core/src/main/java/dev/triumphteam/gui/guis/PaginatedGui.java
@@ -1,18 +1,18 @@
 /**
  * MIT License
- *
+ * <p>
  * Copyright (c) 2021 TriumphTeam
- *
+ * <p>
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal
  * in the Software without restriction, including without limitation the rights
  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  * copies of the Software, and to permit persons to whom the Software is
  * furnished to do so, subject to the following conditions:
- *
+ * <p>
  * The above copyright notice and this permission notice shall be included in all
  * copies or substantial portions of the Software.
- *
+ * <p>
  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
@@ -51,6 +51,7 @@ public class PaginatedGui extends BaseGui {
  * Main constructor to provide a way to create PaginatedGui, uses {@link Component}
  *
  * @param rows The amount of rows the GUI should have
+ * @param pageSize The page size.
  * @param title The GUI's title using {@link Component}
  * @param interactionModifiers A set containing what {@link InteractionModifier} this GUI should have
  * @since 3.0.0
@@ -77,6 +78,7 @@ public PaginatedGui(final int rows, final int pageSize, @NotNull final Component
  /**
  * Alternative constructor for the {@link PaginatedGui} without page size
  *
+ * @param rows Number of rows.
  * @param title The title using {@link Component}
  * @since 3.0.0
  */
@@ -350,6 +352,7 @@ public int getPrevPageNum() {
 
  /**
  * Goes to the next page
+ * @return False if there is no next page.
  */
  public boolean next() {
  if (pageNum + 1 > getPagesNum()) return false;
@@ -359,18 +362,9 @@ public boolean next() {
  return true;
  }
 
- /**
- * Goes to the next page
- *
- * @deprecated Use {@link #next()} instead
- */
- @Deprecated
- public boolean nextPage() {
- return next();
- }
-
  /**
  * Goes to the previous page if possible
+ * @return False if there is no previous page.
  */
  public boolean previous() {
  if (pageNum - 1 == 0) return false;
@@ -380,16 +374,6 @@ public boolean previous() {
  return true;
  }
 
- /**
- * Goes to the previous page if possible
- *
- * @deprecated Use {@link #previous()} instead
- */
- @Deprecated
- public boolean prevPage() {
- return previous();
- }
-
  /**
  * Gets the page item for the GUI listener
  *