From 48499bc1fececde5c6f08df09a51188294683d42 Mon Sep 17 00:00:00 2001
From: bluefireoly <bluefireolymp@gmail.com>
Date: Wed, 15 Jul 2020 14:56:12 +0200
Subject: [PATCH] Added documentation

---
 .../kspigot/extensions/events/InteractEventExtensions.kt | 5 +++++
 .../extensions/events/PrepareItemCraftEventExtensions.kt | 9 +++++++++
 src/main/kotlin/net/axay/kspigot/main/KSpigot.kt         | 9 +++++++++
 3 files changed, 23 insertions(+)

diff --git a/src/main/kotlin/net/axay/kspigot/extensions/events/InteractEventExtensions.kt b/src/main/kotlin/net/axay/kspigot/extensions/events/InteractEventExtensions.kt
index f9a97f1b..1128c6b2 100644
--- a/src/main/kotlin/net/axay/kspigot/extensions/events/InteractEventExtensions.kt
+++ b/src/main/kotlin/net/axay/kspigot/extensions/events/InteractEventExtensions.kt
@@ -10,6 +10,11 @@ import org.bukkit.event.player.PlayerInteractEvent
 import org.bukkit.inventory.EquipmentSlot
 import org.bukkit.inventory.ItemStack
 
+/**
+ * Returns the item used in the interaction
+ * with the use of the [EquipmentSlot] returned
+ * by the value [PlayerInteractEntityEvent.hand].
+ */
 val PlayerInteractEntityEvent.interactItem: ItemStack?
     get() {
         val p: Player = this.player
diff --git a/src/main/kotlin/net/axay/kspigot/extensions/events/PrepareItemCraftEventExtensions.kt b/src/main/kotlin/net/axay/kspigot/extensions/events/PrepareItemCraftEventExtensions.kt
index ea2bff75..006a6ef5 100644
--- a/src/main/kotlin/net/axay/kspigot/extensions/events/PrepareItemCraftEventExtensions.kt
+++ b/src/main/kotlin/net/axay/kspigot/extensions/events/PrepareItemCraftEventExtensions.kt
@@ -4,7 +4,16 @@ import org.bukkit.Material
 import org.bukkit.event.inventory.PrepareItemCraftEvent
 import org.bukkit.inventory.ItemStack
 
+/**
+ * Checks if the event is "cancelled"
+ * by returning if the material of
+ * the result is equal to [Material.AIR].
+ */
 val PrepareItemCraftEvent.isCancelled: Boolean
         get() = this.inventory.result?.type == Material.AIR
 
+/**
+ * "Cancels" this event by
+ * setting the result to [Material.AIR].
+ */
 fun PrepareItemCraftEvent.cancel() { this.inventory.result = ItemStack(Material.AIR) }
\ No newline at end of file
diff --git a/src/main/kotlin/net/axay/kspigot/main/KSpigot.kt b/src/main/kotlin/net/axay/kspigot/main/KSpigot.kt
index c567c10f..d8731789 100644
--- a/src/main/kotlin/net/axay/kspigot/main/KSpigot.kt
+++ b/src/main/kotlin/net/axay/kspigot/main/KSpigot.kt
@@ -3,6 +3,15 @@ package net.axay.kspigot.main
 import net.axay.kspigot.runnables.KRunnableHolder
 import org.bukkit.plugin.java.JavaPlugin
 
+/**
+ * This is the main instance of kSpigot.
+ *
+ * It should be initialized when a plugin using
+ * kSpigot gets enabled.
+ *
+ * Do not forget to call the [shutdown] method
+ * when your plugin gets disabled.
+ */
 class KSpigot(val plugin: JavaPlugin) {
 
     val kRunnableHolder = KRunnableHolder()