did some documentation

This commit is contained in:
5vl 2022-11-21 00:55:55 +01:00
parent 14b986d23b
commit adc71d269a
2 changed files with 12 additions and 0 deletions

View File

@ -2,8 +2,19 @@ package me.fivevl.betterspigot
import org.bukkit.plugin.java.JavaPlugin import org.bukkit.plugin.java.JavaPlugin
/**
* @author 5vl
* @since 0.0.1
*/
object BetterSpigot { object BetterSpigot {
/**
* @return The API users JavaPlugin instance
*/
lateinit var instance: JavaPlugin lateinit var instance: JavaPlugin
/**
* Initializes the API
*/
fun BetterSpigot(plugin: JavaPlugin) { fun BetterSpigot(plugin: JavaPlugin) {
instance = plugin instance = plugin
} }

View File

@ -9,6 +9,7 @@ import net.md_5.bungee.api.ChatColor
object BetterText { object BetterText {
/** /**
* @return The color-translated string * @return The color-translated string
* @sample String#color() - "&aGreen, &cRed and &bBlue".color()
*/ */
fun String.color(): String { fun String.color(): String {
return ChatColor.translateAlternateColorCodes('&', this) return ChatColor.translateAlternateColorCodes('&', this)