Added documentation

2020-07-15 14:56:12 +02:00
parent b6fa27c9a2
commit 48499bc1fe
3 changed files with 23 additions and 0 deletions
--- 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