From ee0b6ae087c22cd1793e509357bde9cb89f83a9f Mon Sep 17 00:00:00 2001
From: bluefireoly <bluefireolymp@gmail.com>
Date: Mon, 28 Sep 2020 23:42:56 +0200
Subject: [PATCH] Added documentation to ipAddressData

---
 .../kotlin/net/axay/kspigot/ipaddress/IPAddressData.kt    | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/src/main/kotlin/net/axay/kspigot/ipaddress/IPAddressData.kt b/src/main/kotlin/net/axay/kspigot/ipaddress/IPAddressData.kt
index e834c280..26e0d7da 100644
--- a/src/main/kotlin/net/axay/kspigot/ipaddress/IPAddressData.kt
+++ b/src/main/kotlin/net/axay/kspigot/ipaddress/IPAddressData.kt
@@ -10,8 +10,16 @@ import java.net.URL
 private const val IP_API = "http://ip-api.com/json/"
 private const val IP_API_FIELDS = "status,message,continent,continentCode,country,countryCode,region,regionName,city,district,zip,lat,lon,timezone,currency,isp,org,query"
 
+/**
+ * @see ipAddressData
+ */
 val Player.ipAddressData get() = ipAddressData()
 
+/**
+ * @param language The preferred language of the result.
+ * @return An object containing all the data which could
+ * be found out about the IP address of the player.
+ */
 fun Player.ipAddressData(language: IPAddressDataLanguage = IPAddressDataLanguage.ENGLISH): IPAddressData? {
 
     return try {