From 50c446f9d94f96bc9dd26d6060eb3fccaf2b5d57 Mon Sep 17 00:00:00 2001
From: EpicKnarvik97 <kristian.knarvik@knett.no>
Date: Fri, 29 Oct 2021 21:19:24 +0200
Subject: [PATCH] Adds package JavaDoc to help anyone who wants to use the
 Stargate API

---
 .../stargate/event/StargateAccessEvent.java   |  3 ++-
 .../stargate/event/StargateDestroyEvent.java  |  2 +-
 .../stargate/event/package-info.java          | 25 +++++++++++++++++++
 .../net/knarcraft/stargate/package-info.java  |  4 +++
 4 files changed, 32 insertions(+), 2 deletions(-)
 create mode 100644 src/main/java/net/knarcraft/stargate/event/package-info.java
 create mode 100644 src/main/java/net/knarcraft/stargate/package-info.java

diff --git a/src/main/java/net/knarcraft/stargate/event/StargateAccessEvent.java b/src/main/java/net/knarcraft/stargate/event/StargateAccessEvent.java
index 843b3d6..3f70dec 100644
--- a/src/main/java/net/knarcraft/stargate/event/StargateAccessEvent.java
+++ b/src/main/java/net/knarcraft/stargate/event/StargateAccessEvent.java
@@ -8,7 +8,8 @@ import org.jetbrains.annotations.NotNull;
 /**
  * This event should be called whenever a player attempts to access a stargate
  *
- * <p>This event can be used to override whether the player should be allowed to access the stargate.</p>
+ * <p>This event is triggered whenever a player enters or activates a stargate. This event can be used to override 
+ * whether the player should be allowed to access the stargate.</p>
  */
 @SuppressWarnings("unused")
 public class StargateAccessEvent extends StargatePlayerEvent {
diff --git a/src/main/java/net/knarcraft/stargate/event/StargateDestroyEvent.java b/src/main/java/net/knarcraft/stargate/event/StargateDestroyEvent.java
index 84bc981..bfcc606 100644
--- a/src/main/java/net/knarcraft/stargate/event/StargateDestroyEvent.java
+++ b/src/main/java/net/knarcraft/stargate/event/StargateDestroyEvent.java
@@ -6,7 +6,7 @@ import org.bukkit.event.HandlerList;
 import org.jetbrains.annotations.NotNull;
 
 /**
- * This event represents an event where a star gate is destroyed or attempted to be destroyed
+ * This event should be called whenever a stargate is destroyed
  *
  * <p>This event can be used to deny or change the cost of a stargate destruction.</p>
  */
diff --git a/src/main/java/net/knarcraft/stargate/event/package-info.java b/src/main/java/net/knarcraft/stargate/event/package-info.java
new file mode 100644
index 0000000..abebf8b
--- /dev/null
+++ b/src/main/java/net/knarcraft/stargate/event/package-info.java
@@ -0,0 +1,25 @@
+/**
+ * Events for any plugins wanting to interact with the Stargate plugin
+ *
+ * <p>This package contains several events used for interactions with Stargate. All events can be cancelled. For
+ * several of the events, it is possible to overrule permissions. A general overview of the events' usage:</p>
+ *
+ * <ul>
+ *     <li>The StargateAccessEvent is called whenever a player clicks a stargate's sign, and when a player enters a
+ *     Stargate. It can be used to override whether the access should be allowed or denied.</li>
+ *     <li>The StargateActivateEvent is called whenever a player activates a stargate (uses the stargate's sign). It
+ *     can be used to override which destinations are available to the player.</li>
+ *     <li>The StargateCloseEvent is called whenever a stargate is closed. Forcing the stargate closed can be toggled.</li>
+ *     <li>The StargateCreateEvent is called whenever a new stargate is created. Its deny value can be overridden, the
+ *     cost can be changed</li>
+ *     <li>The StargateDeactivateEvent is called whenever a stargate is deactivated.</li>
+ *     <li>The StargateDestroyEvent is called whenever a stargate is destroyed. Its deny value can be overridden or the
+ *     cost can be changed.</li>
+ *     <li>The StargateEntityPortalEvent is called whenever an entity teleports through a stargate. The exit location
+ *     can be changed.</li>
+ *     <li>The StargateOpenEvent is called whenever a stargate is opened. Forcing the stargate open can be toggled.</li>
+ *     <li>The StargatePlayerPortalEvent is called whenever a player teleports through a stargate. The exit location can
+ *     be changed.</li>
+ * </ul>
+ */
+package net.knarcraft.stargate.event;
\ No newline at end of file
diff --git a/src/main/java/net/knarcraft/stargate/package-info.java b/src/main/java/net/knarcraft/stargate/package-info.java
new file mode 100644
index 0000000..c0f22f3
--- /dev/null
+++ b/src/main/java/net/knarcraft/stargate/package-info.java
@@ -0,0 +1,4 @@
+/**
+ * The root package of the Stargate plugin. Contains the main Stargate.java file
+ */
+package net.knarcraft.stargate;
\ No newline at end of file