From e59e4b1d62c555bb0aeaea0cb3619aa23666b6e9 Mon Sep 17 00:00:00 2001 From: Gabriel Tofvesson Date: Sun, 25 Apr 2021 00:25:11 +0200 Subject: [PATCH] Add documentation --- src/dev/w1zzrd/invtweaks/command/MagnetCommandExecutor.java | 3 +++ src/dev/w1zzrd/invtweaks/command/SortCommandExecutor.java | 3 +++ src/dev/w1zzrd/invtweaks/command/package-info.java | 4 ++++ src/dev/w1zzrd/invtweaks/listener/SortListener.java | 3 +++ src/dev/w1zzrd/invtweaks/listener/StackReplaceListener.java | 3 +++ src/dev/w1zzrd/invtweaks/listener/package-info.java | 4 ++++ 6 files changed, 20 insertions(+) create mode 100644 src/dev/w1zzrd/invtweaks/command/package-info.java create mode 100644 src/dev/w1zzrd/invtweaks/listener/package-info.java diff --git a/src/dev/w1zzrd/invtweaks/command/MagnetCommandExecutor.java b/src/dev/w1zzrd/invtweaks/command/MagnetCommandExecutor.java index 36c1f46..ccee5b6 100644 --- a/src/dev/w1zzrd/invtweaks/command/MagnetCommandExecutor.java +++ b/src/dev/w1zzrd/invtweaks/command/MagnetCommandExecutor.java @@ -19,6 +19,9 @@ import java.util.logging.Logger; import static dev.w1zzrd.invtweaks.InvTweaksPlugin.LOG_PLUGIN_NAME; +/** + * Handler for executions of /magnet command + */ public class MagnetCommandExecutor implements CommandExecutor { private static final Logger logger = Bukkit.getLogger(); diff --git a/src/dev/w1zzrd/invtweaks/command/SortCommandExecutor.java b/src/dev/w1zzrd/invtweaks/command/SortCommandExecutor.java index ddb5577..6b7d289 100644 --- a/src/dev/w1zzrd/invtweaks/command/SortCommandExecutor.java +++ b/src/dev/w1zzrd/invtweaks/command/SortCommandExecutor.java @@ -21,6 +21,9 @@ import java.util.logging.Logger; import static dev.w1zzrd.invtweaks.InvTweaksPlugin.LOG_PLUGIN_NAME; import static org.bukkit.Material.*; +/** + * Handler for executions of /sort command + */ public class SortCommandExecutor implements CommandExecutor { private static final Logger logger = Bukkit.getLogger(); diff --git a/src/dev/w1zzrd/invtweaks/command/package-info.java b/src/dev/w1zzrd/invtweaks/command/package-info.java new file mode 100644 index 0000000..613ffbc --- /dev/null +++ b/src/dev/w1zzrd/invtweaks/command/package-info.java @@ -0,0 +1,4 @@ +/** + * Command handlers for the InventoryTweaks plugin + */ +package dev.w1zzrd.invtweaks.command; \ No newline at end of file diff --git a/src/dev/w1zzrd/invtweaks/listener/SortListener.java b/src/dev/w1zzrd/invtweaks/listener/SortListener.java index 3a8c81a..8354abc 100644 --- a/src/dev/w1zzrd/invtweaks/listener/SortListener.java +++ b/src/dev/w1zzrd/invtweaks/listener/SortListener.java @@ -14,6 +14,9 @@ import java.util.logging.Logger; import static dev.w1zzrd.invtweaks.InvTweaksPlugin.LOG_PLUGIN_NAME; +/** + * Handler for events/interactions that should trigger a /sort command + */ public class SortListener implements Listener { private static final Logger logger = Bukkit.getLogger(); diff --git a/src/dev/w1zzrd/invtweaks/listener/StackReplaceListener.java b/src/dev/w1zzrd/invtweaks/listener/StackReplaceListener.java index c8b42b6..59dea5d 100644 --- a/src/dev/w1zzrd/invtweaks/listener/StackReplaceListener.java +++ b/src/dev/w1zzrd/invtweaks/listener/StackReplaceListener.java @@ -12,6 +12,9 @@ import java.util.logging.Logger; import static dev.w1zzrd.invtweaks.InvTweaksPlugin.LOG_PLUGIN_NAME; +/** + * Handler for events/interactions that should trigger stack replacements in a players inventory + */ public class StackReplaceListener implements Listener { private static final int MAX_MAIN_INV = 35; diff --git a/src/dev/w1zzrd/invtweaks/listener/package-info.java b/src/dev/w1zzrd/invtweaks/listener/package-info.java new file mode 100644 index 0000000..6781c69 --- /dev/null +++ b/src/dev/w1zzrd/invtweaks/listener/package-info.java @@ -0,0 +1,4 @@ +/** + * Event listeners for the InventoryTweaks plugin + */ +package dev.w1zzrd.invtweaks.listener; \ No newline at end of file