Merge pull request #23 from D0gmaDev/main

Change outdated Item.java javadoc comments
This commit is contained in:
NichtStudioCode 2023-02-27 17:10:09 +01:00 committed by GitHub
commit 62e1a2c591
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

@ -29,7 +29,7 @@ public interface Item {
void addWindow(Window window); void addWindow(Window window);
/** /**
* Removes an {@link Window} from the window set, telling the {@link Item} that it * Removes a {@link Window} from the window set, telling the {@link Item} that it
* is no longer being displayed in that {@link Window}. * is no longer being displayed in that {@link Window}.
* *
* @param window The {@link Window} the {@link Item} is no longer displayed in. * @param window The {@link Window} the {@link Item} is no longer displayed in.
@ -46,19 +46,19 @@ public interface Item {
Set<Window> getWindows(); Set<Window> getWindows();
/** /**
* Calls the {@link Window#handleItemProviderUpdate(Item)} method on every {@link Window} * Calls a refresh method on every {@link Window} in which this {@link Item} is displayed,
* in the set, notifying them that the {@link ItemProvider} has been updated * notifying them that the {@link ItemProvider} has been updated,
* and the {@link ItemStack} inside the {@link Window}'s {@link Inventory} should * thus the {@link ItemStack} inside the {@link Window}'s {@link Inventory} should
* be replaced. * be replaced.
*/ */
void notifyWindows(); void notifyWindows();
/** /**
* A method called if the the {@link ItemStack} associated to this {@link Item} * A method called if the {@link ItemStack} associated to this {@link Item}
* has been clicked by a player. * has been clicked by a player.
* *
* @param clickType The {@link ClickType} the {@link Player} did. * @param clickType The {@link ClickType} the {@link Player} performed.
* @param player The {@link Player} who clicked on the {@link ItemStack} * @param player The {@link Player} who clicked on the {@link ItemStack}.
* @param event The {@link InventoryClickEvent} associated with this click. * @param event The {@link InventoryClickEvent} associated with this click.
*/ */
void handleClick(@NotNull ClickType clickType, @NotNull Player player, @NotNull InventoryClickEvent event); void handleClick(@NotNull ClickType clickType, @NotNull Player player, @NotNull InventoryClickEvent event);