Add documentation to custom Plex events + config

src/main/java/dev/plex/event/AdminAddEvent.java

@@ -6,12 +6,22 @@ import org.bukkit.command.CommandSender;
 import org.bukkit.event.Event;
 import org.bukkit.event.HandlerList;
 
+/**
+ * Event that is ran when a player is added to the admin list
+ */
 @Data
 public class AdminAddEvent extends Event
 {
     private static final HandlerList handlers = new HandlerList();
 
+    /**
+     * The sender who added the player
+     */
     private final CommandSender sender;
+
+    /**
+     * The PlexPlayer that was added
+     */
     private final PlexPlayer plexPlayer;
 
     @Override

src/main/java/dev/plex/event/AdminRemoveEvent.java

@@ -6,12 +6,22 @@ import org.bukkit.command.CommandSender;
 import org.bukkit.event.Event;
 import org.bukkit.event.HandlerList;
 
+/**
+ * Event that is ran when a player is removed from the admin list
+ */
 @Data
 public class AdminRemoveEvent extends Event
 {
     private static final HandlerList handlers = new HandlerList();
 
+    /**
+     * The sender who added the player
+     */
     private final CommandSender sender;
+
+    /**
+     * The PlexPlayer that was removed
+     */
     private final PlexPlayer plexPlayer;
 
     @Override

src/main/java/dev/plex/event/AdminSetRankEvent.java

@@ -7,13 +7,27 @@ import org.bukkit.command.CommandSender;
 import org.bukkit.event.Event;
 import org.bukkit.event.HandlerList;
 
+/**
+ * Event that is ran when an admin's rank is set
+ */
 @Data
 public class AdminSetRankEvent extends Event
 {
     private static final HandlerList handlers = new HandlerList();
 
+    /**
+     * The sender who added the player
+     */
     private final CommandSender sender;
+
+    /**
+     * The PlexPlayer that was removed
+     */
     private final PlexPlayer plexPlayer;
+
+    /**
+     * The rank the player was set to
+     */
     private final Rank rank;
 
 

src/main/java/dev/plex/event/PunishedPlayerEvent.java

@@ -8,13 +8,28 @@ import org.bukkit.Bukkit;
 import org.bukkit.event.Cancellable;
 import org.bukkit.event.player.PlayerEvent;
 
+/**
+ * Superclass for punishment events
+ */
 @Getter
 public abstract class PunishedPlayerEvent extends PlayerEvent implements Cancellable
 {
+    /**
+     * The player who was punished
+     */
     protected PunishedPlayer punishedPlayer;
-    @Setter
-    protected boolean cancelled;
 
+    /**
+     * Whether the event was cancelled
+     */
+    @Setter
+    protected boolean cancelled; //TODO: unsure if cancelling the event does anything
+
+    /**
+     * Creates an event object
+     * @param punishedPlayer The player who was punished
+     * @see PunishedPlayer
+     */
     protected PunishedPlayerEvent(PunishedPlayer punishedPlayer)
     {
         super(Bukkit.getPlayer(UUID.fromString(punishedPlayer.getUuid())));

src/main/java/dev/plex/event/PunishedPlayerFreezeEvent.java

@@ -5,16 +5,25 @@ import lombok.Getter;
 import org.bukkit.event.Cancellable;
 import org.bukkit.event.HandlerList;
 
+//TODO: Event doesn't look like it is called
+/**
+ * Event that is called when a player is frozen or unfrozen
+ */
 @Getter
 public class PunishedPlayerFreezeEvent extends PunishedPlayerEvent implements Cancellable
 {
     private static final HandlerList handlers = new HandlerList();
 
     /**
-     * Status of the Punished Player being frozen before the event's occurrence.
+     * New frozen state of the player
      */
     private final boolean frozen;
 
+    /**
+     * Creates a new event instance
+     * @param punishedPlayer The player who was punished
+     * @param frozen The new frozen status
+     */
     public PunishedPlayerFreezeEvent(PunishedPlayer punishedPlayer, boolean frozen)
     {
         super(punishedPlayer);

src/main/java/dev/plex/event/PunishedPlayerMuteEvent.java

@@ -5,16 +5,25 @@ import lombok.Getter;
 import org.bukkit.event.Cancellable;
 import org.bukkit.event.HandlerList;
 
+//TODO: Event doesn't look like it is called
+/**
+ * Event that is called when a player is frozen or unfrozen
+ */
 @Getter
 public class PunishedPlayerMuteEvent extends PunishedPlayerEvent implements Cancellable
 {
     private static final HandlerList handlers = new HandlerList();
 
     /**
-     * Status of the Punished Player being frozen before the event's occurrence.
+     * New muted state of the player
      */
     private final boolean muted;
 
+    /**
+     * Creates a new event instance
+     * @param punishedPlayer The player who was punished
+     * @param muted The new muted status
+     */
     public PunishedPlayerMuteEvent(PunishedPlayer punishedPlayer, boolean muted)
     {
         super(punishedPlayer);