From c83bcecac2455563fe09d5ec90662723145d9423 Mon Sep 17 00:00:00 2001
From: "Erik C. Thauvin" <erik@thauvin.net>
Date: Tue, 4 Jun 2024 21:33:07 -0700
Subject: [PATCH] Added missing parameters documentation

---
 src/main/kotlin/net/thauvin/erik/isgd/LookupConfig.kt  | 5 +++++
 src/main/kotlin/net/thauvin/erik/isgd/ShortenConfig.kt | 2 ++
 2 files changed, 7 insertions(+)

diff --git a/src/main/kotlin/net/thauvin/erik/isgd/LookupConfig.kt b/src/main/kotlin/net/thauvin/erik/isgd/LookupConfig.kt
index 9f8d285..16f698f 100644
--- a/src/main/kotlin/net/thauvin/erik/isgd/LookupConfig.kt
+++ b/src/main/kotlin/net/thauvin/erik/isgd/LookupConfig.kt
@@ -44,6 +44,11 @@ class LookupConfig private constructor(builder: Builder) {
      * Configures the parameters to lookup an is.gd shortlink.
      *
      * See the [is.gd Lookup]() API.
+     *
+     * @param shorturl The shorturl parameter is the shortened is.gd URL that you want to look up. You can either submit
+     * the full address (e.g. `https://is.gd/example`) or only the unique part (e.g. `example`). The address you submit
+     * should be properly formed; the API lookup function is not guaranteed to handle malformed URLs the same way as
+     * when you visit them manually.
      */
     data class Builder(var shorturl: String) {
         var callback: String = ""
diff --git a/src/main/kotlin/net/thauvin/erik/isgd/ShortenConfig.kt b/src/main/kotlin/net/thauvin/erik/isgd/ShortenConfig.kt
index c4a9d9e..c71c36a 100644
--- a/src/main/kotlin/net/thauvin/erik/isgd/ShortenConfig.kt
+++ b/src/main/kotlin/net/thauvin/erik/isgd/ShortenConfig.kt
@@ -46,6 +46,8 @@ class ShortenConfig private constructor(builder: Builder) {
      * Configures the parameters to create an is.gd shortlink.
      *
      * See the [is.gd Shortening](https://is.gd/apishorteningreference.php) API.
+     *
+     * @param url The url parameter is the address that you want to shorten.
      */
     data class Builder(var url: String) {
         var shorturl: String = ""