From 5f40c8ba2466b5029e413bf99a173e4d931b648a Mon Sep 17 00:00:00 2001 From: "Erik C. Thauvin" Date: Mon, 25 Sep 2023 11:33:41 -0700 Subject: [PATCH] Updated docs --- README.md | 8 +- config/dokka/packages.md | 2 +- .../-create-config/-builder/-builder.html | 48 +- .../-create-config/-builder/build.html | 48 +- .../-create-config/-builder/deeplinks.html | 50 +- .../-create-config/-builder/domain.html | 50 +- .../-create-config/-builder/group_guid.html | 50 +- .../-create-config/-builder/index.html | 159 +-- .../-create-config/-builder/long-url.html | 48 +- .../-create-config/-builder/long_url.html | 48 +- .../-create-config/-builder/tags.html | 50 +- .../-create-config/-builder/title.html | 50 +- .../-create-config/-builder/to-json.html | 50 +- .../-create-config/deep-links.html | 48 +- .../-create-config/domain.html | 48 +- .../-create-config/group_guid.html | 48 +- .../-create-config/index.html | 50 +- .../-create-config/long_url.html | 48 +- .../-create-config/tags.html | 48 +- .../-create-config/title.html | 48 +- .../-create-config/to-json.html | 48 +- .../-update-config/-builder/-builder.html | 48 +- .../-update-config/-builder/archived.html | 48 +- .../-update-config/-builder/bitlink.html | 48 +- .../-update-config/-builder/build.html | 48 +- .../-update-config/-builder/client-id.html | 48 +- .../-update-config/-builder/client_id.html | 48 +- .../-update-config/-builder/created-at.html | 48 +- .../-update-config/-builder/created-by.html | 48 +- .../-update-config/-builder/created_at.html | 48 +- .../-update-config/-builder/created_by.html | 48 +- .../-builder/custom-bitlinks.html | 48 +- .../-builder/custom_bitlinks.html | 48 +- .../-update-config/-builder/deeplinks.html | 48 +- .../-update-config/-builder/id.html | 48 +- .../-update-config/-builder/index.html | 48 +- .../-update-config/-builder/link.html | 48 +- .../-update-config/-builder/long-url.html | 48 +- .../-update-config/-builder/long_url.html | 48 +- .../-update-config/-builder/references.html | 48 +- .../-update-config/-builder/tags.html | 48 +- .../-update-config/-builder/title.html | 48 +- .../-update-config/-builder/to-json.html | 48 +- .../-update-config/archived.html | 48 +- .../-update-config/bitlink.html | 48 +- .../-update-config/client_id.html | 48 +- .../-update-config/created_at.html | 48 +- .../-update-config/created_by.html | 48 +- .../-update-config/custom_bitlinks.html | 48 +- .../-update-config/deep-links.html | 48 +- .../-update-config/id.html | 48 +- .../-update-config/index.html | 48 +- .../-update-config/link.html | 48 +- .../-update-config/long_url.html | 48 +- .../-update-config/references.html | 48 +- .../-update-config/tags.html | 48 +- .../-update-config/title.html | 48 +- .../-update-config/to-json.html | 48 +- .../net.thauvin.erik.bitly.config/index.html | 48 +- .../-bitlinks/-bitlinks.html | 48 +- .../-bitlinks/clicks.html | 48 +- .../-bitlinks/create.html | 48 +- .../-bitlinks/expand.html | 48 +- .../-bitlinks/index.html | 48 +- .../-bitlinks/last-call-response.html | 48 +- .../-bitlinks/shorten.html | 48 +- .../-bitlinks/update.html | 48 +- .../net.thauvin.erik.bitly/-bitly/-bitly.html | 48 +- .../-bitly/access-token.html | 48 +- .../-bitly/bitlinks.html | 48 +- .../net.thauvin.erik.bitly/-bitly/call.html | 48 +- .../net.thauvin.erik.bitly/-bitly/index.html | 48 +- .../-call-response/-call-response.html | 48 +- .../-call-response/body.html | 48 +- .../-call-response/description.html | 48 +- .../-call-response/index.html | 48 +- .../-call-response/is-bad-request.html | 48 +- .../-call-response/is-created.html | 48 +- .../-call-response/is-expectation-failed.html | 48 +- .../-call-response/is-forbidden.html | 48 +- .../-call-response/is-gone.html | 48 +- .../-call-response/is-internal-error.html | 48 +- .../-call-response/is-not-found.html | 48 +- .../-call-response/is-successful.html | 48 +- .../is-temporarily-unavailable.html | 48 +- .../-call-response/is-too-many-requests.html | 48 +- .../is-unprocessable-entity.html | 48 +- .../-call-response/is-upgrade-required.html | 48 +- .../-call-response/message.html | 48 +- .../-call-response/status-code.html | 48 +- .../-constants/-a-p-i_-b-a-s-e_-u-r-l.html | 48 +- .../-constants/-e-m-p-t-y.html | 48 +- .../-constants/-e-m-p-t-y_-j-s-o-n.html | 48 +- .../-e-n-v_-a-c-c-e-s-s_-t-o-k-e-n.html | 48 +- .../-constants/-f-a-l-s-e.html | 48 +- .../-constants/-t-r-u-e.html | 48 +- .../-constants/index.html | 48 +- .../-methods/-d-e-l-e-t-e/index.html | 48 +- .../-methods/-g-e-t/index.html | 48 +- .../-methods/-p-a-t-c-h/index.html | 48 +- .../-methods/-p-o-s-t/index.html | 48 +- .../-methods/entries.html | 80 ++ .../-methods/index.html | 65 +- .../-methods/value-of.html | 48 +- .../-methods/values.html | 48 +- .../-units/-d-a-y/index.html | 48 +- .../-units/-h-o-u-r/index.html | 48 +- .../-units/-m-i-n-u-t-e/index.html | 48 +- .../-units/-m-o-n-t-h/index.html | 48 +- .../-units/-w-e-e-k/index.html | 48 +- .../-units/entries.html | 80 ++ .../net.thauvin.erik.bitly/-units/index.html | 65 +- .../-units/value-of.html | 48 +- .../net.thauvin.erik.bitly/-units/values.html | 48 +- .../net.thauvin.erik.bitly/-utils/call.html | 48 +- .../net.thauvin.erik.bitly/-utils/index.html | 48 +- .../-utils/is-severe-loggable.html | 48 +- .../-utils/is-valid-url.html | 48 +- .../net.thauvin.erik.bitly/-utils/logger.html | 48 +- .../-utils/remove-http.html | 48 +- .../-utils/to-end-point.html | 48 +- .../net.thauvin.erik.bitly/index.html | 48 +- docs/bitly-shorten/package-list | 9 +- docs/images/burger.svg | 5 + docs/images/nav-icons/typealias-kotlin.svg | 9 + docs/images/theme-toggle.svg | 5 +- docs/index.html | 50 +- docs/scripts/main.js | 2 +- docs/scripts/pages.json | 2 +- docs/scripts/platform-content-handler.js | 12 +- docs/styles/font-jb-sans-auto.css | 32 + docs/styles/logo-styles.css | 18 +- docs/styles/main.css | 2 +- docs/styles/style.css | 1034 ++++++++++------- 134 files changed, 4209 insertions(+), 2964 deletions(-) create mode 100644 docs/bitly-shorten/net.thauvin.erik.bitly/-methods/entries.html create mode 100644 docs/bitly-shorten/net.thauvin.erik.bitly/-units/entries.html create mode 100644 docs/images/burger.svg create mode 100644 docs/images/nav-icons/typealias-kotlin.svg create mode 100644 docs/styles/font-jb-sans-auto.css diff --git a/README.md b/README.md index 0d182e8..c4bb8f6 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,8 @@ [![License (3-Clause BSD)](https://img.shields.io/badge/license-BSD%203--Clause-blue.svg?style=flat-square)](https://opensource.org/licenses/BSD-3-Clause) -[![Kotlin](https://img.shields.io/badge/kotlin-1.8.22-7f52ff)](https://kotlinlang.org/) +[![Kotlin](https://img.shields.io/badge/kotlin-1.9.10-7f52ff)](https://kotlinlang.org/) [![Nexus Snapshot](https://img.shields.io/nexus/s/net.thauvin.erik/bitly-shorten?label=snapshot&server=https%3A%2F%2Foss.sonatype.org%2F)](https://oss.sonatype.org/content/repositories/snapshots/net/thauvin/erik/bitly-shorten/) [![Release](https://img.shields.io/github/release/ethauvin/bitly-shorten.svg)](https://github.com/ethauvin/bitly-shorten/releases/latest) -[![Maven Central](https://img.shields.io/maven-central/v/net.thauvin.erik/bitly-shorten.svg?label=maven%20central)](https://search.maven.org/search?q=g:%22net.thauvin.erik%22%20AND%20a:%22bitly-shorten%22) +[![Maven Central](https://img.shields.io/maven-central/v/net.thauvin.erik/bitly-shorten.svg?color=blue)](https://central.sonatype.com/artifact/net.thauvin.erik/bitly-shorten) [![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=ethauvin_bitly-shorten&metric=alert_status)](https://sonarcloud.io/dashboard?id=ethauvin_bitly-shorten) [![GitHub CI](https://github.com/ethauvin/bitly-shorten/actions/workflows/gradle.yml/badge.svg)](https://github.com/ethauvin/bitly-shorten/actions/workflows/gradle.yml) @@ -67,7 +67,7 @@ dependencies { } ``` -Instructions for using with Maven, Ivy, etc. can be found on [Maven Central](https://search.maven.org/artifact/net.thauvin.erik/bitly-shorten/0.9.3/jar). +Instructions for using with Maven, Ivy, etc. can be found on [Maven Central](https://central.sonatype.com/artifact/net.thauvin.erik/bitly-shorten). ## Java @@ -77,7 +77,7 @@ To make it easier to use the library with Java, configuration builders are avail var config = new CreateConfig.Builder() .title("Erik's Weblog") .tags(new String[] { "blog", "weblog"}) - .long_url("https://erik.thauvin.net/blog") + .longUrl("https://erik.thauvin.net/blog") .build(); bitly.bitlinks().create(config); diff --git a/config/dokka/packages.md b/config/dokka/packages.md index ccf2afd..a55184f 100644 --- a/config/dokka/packages.md +++ b/config/dokka/packages.md @@ -2,7 +2,7 @@ [Bitly Shortener for Kotlin, Java & Android](https://github.com/ethauvin/bitly-shorten) -A simple implementation of the [Bitly](https://bit.ly/) link shortening (Bitlinks) [API v4](https://dev.bitly.com/api-reference). +A simple implementation of the [Bitly](https://bit.ly/) link shortening (Bitlinks) [API v4](https://dev.bitly.com/api-reference/). # Package net.thauvin.erik.bitly diff --git a/docs/bitly-shorten/net.thauvin.erik.bitly.config/-create-config/-builder/-builder.html b/docs/bitly-shorten/net.thauvin.erik.bitly.config/-create-config/-builder/-builder.html index 4896895..bb895b3 100644 --- a/docs/bitly-shorten/net.thauvin.erik.bitly.config/-create-config/-builder/-builder.html +++ b/docs/bitly-shorten/net.thauvin.erik.bitly.config/-create-config/-builder/-builder.html @@ -1,10 +1,11 @@ - + Builder + + - + @@ -32,28 +34,33 @@ -