From adc71d269a7dab2012b1fa4972b4b97429fe40ce Mon Sep 17 00:00:00 2001
From: 5vl <nederlandmax@gmail.com>
Date: Mon, 21 Nov 2022 00:55:55 +0100
Subject: [PATCH] did some documentation

---
 src/main/java/me/fivevl/betterspigot/BetterSpigot.kt | 11 +++++++++++
 src/main/java/me/fivevl/betterspigot/BetterText.kt   |  1 +
 2 files changed, 12 insertions(+)

diff --git a/src/main/java/me/fivevl/betterspigot/BetterSpigot.kt b/src/main/java/me/fivevl/betterspigot/BetterSpigot.kt
index ef8f048..eac3b4e 100644
--- a/src/main/java/me/fivevl/betterspigot/BetterSpigot.kt
+++ b/src/main/java/me/fivevl/betterspigot/BetterSpigot.kt
@@ -2,8 +2,19 @@ package me.fivevl.betterspigot
 
 import org.bukkit.plugin.java.JavaPlugin
 
+/**
+ * @author 5vl
+ * @since 0.0.1
+ */
 object BetterSpigot {
+    /**
+     * @return The API users JavaPlugin instance
+     */
     lateinit var instance: JavaPlugin
+
+    /**
+     * Initializes the API
+     */
     fun BetterSpigot(plugin: JavaPlugin) {
         instance = plugin
     }
diff --git a/src/main/java/me/fivevl/betterspigot/BetterText.kt b/src/main/java/me/fivevl/betterspigot/BetterText.kt
index 16eaad5..65bb231 100644
--- a/src/main/java/me/fivevl/betterspigot/BetterText.kt
+++ b/src/main/java/me/fivevl/betterspigot/BetterText.kt
@@ -9,6 +9,7 @@ import net.md_5.bungee.api.ChatColor
 object BetterText {
     /**
      * @return The color-translated string
+     * @sample String#color() - "&aGreen, &cRed and &bBlue".color()
      */
     fun String.color(): String {
         return ChatColor.translateAlternateColorCodes('&', this)