Skip to content

Commit

Permalink
Added missing parameters documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
ethauvin committed Jun 5, 2024
1 parent e20934f commit c83bcec
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 0 deletions.
5 changes: 5 additions & 0 deletions src/main/kotlin/net/thauvin/erik/isgd/LookupConfig.kt
Original file line number Diff line number Diff line change
Expand Up @@ -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 = ""
Expand Down
2 changes: 2 additions & 0 deletions src/main/kotlin/net/thauvin/erik/isgd/ShortenConfig.kt
Original file line number Diff line number Diff line change
Expand Up @@ -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 = ""
Expand Down

0 comments on commit c83bcec

Please sign in to comment.