From b901d96b1102521be5d589593ca79d64bd737fad Mon Sep 17 00:00:00 2001 From: "Erik C. Thauvin" Date: Wed, 18 Oct 2023 19:06:21 -0700 Subject: [PATCH] Updated docs --- .../net.thauvin.erik.bitly/-utils/call.html | 2 +- .../net.thauvin.erik.bitly/-utils/index.html | 2 +- .../-utils/is-severe-loggable.html | 2 +- .../-utils/is-valid-url.html | 2 +- .../net.thauvin.erik.bitly/-utils/logger.html | 2 +- .../-utils/remove-http.html | 2 +- .../-utils/to-end-point.html | 2 +- docs/images/anchor-copy-button.svg | 6 +- docs/images/arrow_down.svg | 6 +- docs/images/burger.svg | 6 +- docs/images/copy-icon.svg | 6 +- docs/images/copy-successful-icon.svg | 6 +- docs/images/footer-go-to-link.svg | 6 +- docs/images/go-to-top-icon.svg | 6 +- docs/images/logo-icon.svg | 6 +- .../nav-icons/abstract-class-kotlin.svg | 4 + docs/images/nav-icons/annotation-kotlin.svg | 4 + docs/images/nav-icons/class-kotlin.svg | 4 + docs/images/nav-icons/enum-kotlin.svg | 4 + docs/images/nav-icons/field-value.svg | 4 + docs/images/nav-icons/field-variable.svg | 4 + docs/images/nav-icons/interface-kotlin.svg | 4 + docs/images/nav-icons/object.svg | 4 + docs/images/nav-icons/typealias-kotlin.svg | 4 + docs/images/theme-toggle.svg | 6 +- docs/scripts/clipboard.js | 4 + docs/scripts/navigation-loader.js | 4 + docs/scripts/platform-content-handler.js | 4 + .../symbol-parameters-wrapper_deferred.js | 123 ++++++++---------- docs/styles/font-jb-sans-auto.css | 4 + docs/styles/logo-styles.css | 4 + docs/styles/main.css | 10 +- docs/styles/prism.css | 4 + docs/styles/style.css | 6 +- 34 files changed, 177 insertions(+), 90 deletions(-) diff --git a/docs/bitly-shorten/net.thauvin.erik.bitly/-utils/call.html b/docs/bitly-shorten/net.thauvin.erik.bitly/-utils/call.html index 273a5e4..7f8052c 100644 --- a/docs/bitly-shorten/net.thauvin.erik.bitly/-utils/call.html +++ b/docs/bitly-shorten/net.thauvin.erik.bitly/-utils/call.html @@ -66,7 +66,7 @@

call

-
@JvmStatic
@JvmOverloads
fun call(accessToken: String, endPoint: String, params: Map<String, Any> = emptyMap(), method: Methods = Methods.POST): CallResponse(source)

Executes an API call.

Return

A CallResponse object.

Parameters

accessToken

The API access token.

endPoint

The REST endpoint URI. (eg. https://api-ssl.bitly.com/v4/shorten)

params

The request parameters key/value map.

method

The submission Method.

+
@JvmStatic
@JvmOverloads
fun call(accessToken: String, endPoint: String, params: Map<String, Any> = emptyMap(), method: Methods = Methods.POST): CallResponse(source)

Executes an API call.

Return

A CallResponse object.

Parameters

accessToken

The API access token.

endPoint

The REST endpoint URI. (eg. https://api-ssl.bitly.com/v4/shorten)

params

The request parameters key/value map.

method

The submission Method.

© 2023 Copyrightbitly-shorten/net.thauvin.erik.bitly/Utils

Utils

-
object Utils(source)

Provides useful generic functions.

+
object Utils(source)

Provides useful generic functions.

diff --git a/docs/bitly-shorten/net.thauvin.erik.bitly/-utils/is-severe-loggable.html b/docs/bitly-shorten/net.thauvin.erik.bitly/-utils/is-severe-loggable.html index 5c71e03..4586331 100644 --- a/docs/bitly-shorten/net.thauvin.erik.bitly/-utils/is-severe-loggable.html +++ b/docs/bitly-shorten/net.thauvin.erik.bitly/-utils/is-severe-loggable.html @@ -66,7 +66,7 @@

isSevereLoggable

-
fun Logger.isSevereLoggable(): Boolean(source)

Determines if Level.SEVERE logging is enabled.

+
fun Logger.isSevereLoggable(): Boolean(source)

Determines if Level.SEVERE logging is enabled.

© 2023 Copyright

isValidUrl

-
@JvmStatic
fun String.isValidUrl(): Boolean(source)

Validates a URL.

+
@JvmStatic
fun String.isValidUrl(): Boolean(source)

Validates a URL.

© 2023 Copyright

logger

-
@JvmStatic
val logger: Logger(source)

The logger instance.

+
@JvmStatic
val logger: Logger(source)

The logger instance.

© 2023 Copyright

removeHttp

-
@JvmStatic
fun String.removeHttp(): String(source)

Removes http(s) scheme from string.

+
@JvmStatic
fun String.removeHttp(): String(source)

Removes http(s) scheme from string.

© 2023 Copyright

toEndPoint

-
@JvmStatic
fun String.toEndPoint(): String(source)

Builds the full API endpoint URL using the Constants.API_BASE_URL.

+
@JvmStatic
fun String.toEndPoint(): String(source)

Builds the full API endpoint URL using the Constants.API_BASE_URL.

© 2023 Copyright + - \ No newline at end of file + diff --git a/docs/images/arrow_down.svg b/docs/images/arrow_down.svg index c0388de..639aaf1 100644 --- a/docs/images/arrow_down.svg +++ b/docs/images/arrow_down.svg @@ -1,3 +1,7 @@ + + - \ No newline at end of file + diff --git a/docs/images/burger.svg b/docs/images/burger.svg index d6dcefc..fcca732 100644 --- a/docs/images/burger.svg +++ b/docs/images/burger.svg @@ -1,5 +1,9 @@ + + - \ No newline at end of file + diff --git a/docs/images/copy-icon.svg b/docs/images/copy-icon.svg index 61440f0..2cb02ec 100644 --- a/docs/images/copy-icon.svg +++ b/docs/images/copy-icon.svg @@ -1,3 +1,7 @@ + + - \ No newline at end of file + diff --git a/docs/images/copy-successful-icon.svg b/docs/images/copy-successful-icon.svg index 1865f73..c4b9538 100644 --- a/docs/images/copy-successful-icon.svg +++ b/docs/images/copy-successful-icon.svg @@ -1,3 +1,7 @@ + + - \ No newline at end of file + diff --git a/docs/images/footer-go-to-link.svg b/docs/images/footer-go-to-link.svg index 0137e22..a87add7 100644 --- a/docs/images/footer-go-to-link.svg +++ b/docs/images/footer-go-to-link.svg @@ -1,3 +1,7 @@ + + - \ No newline at end of file + diff --git a/docs/images/go-to-top-icon.svg b/docs/images/go-to-top-icon.svg index d987f3e..abc3d1c 100644 --- a/docs/images/go-to-top-icon.svg +++ b/docs/images/go-to-top-icon.svg @@ -1,4 +1,8 @@ + + - \ No newline at end of file + diff --git a/docs/images/logo-icon.svg b/docs/images/logo-icon.svg index 1fea087..e42f957 100644 --- a/docs/images/logo-icon.svg +++ b/docs/images/logo-icon.svg @@ -1,3 +1,7 @@ + + @@ -7,4 +11,4 @@ - \ No newline at end of file + diff --git a/docs/images/nav-icons/abstract-class-kotlin.svg b/docs/images/nav-icons/abstract-class-kotlin.svg index a2069b8..19d6148 100644 --- a/docs/images/nav-icons/abstract-class-kotlin.svg +++ b/docs/images/nav-icons/abstract-class-kotlin.svg @@ -1,3 +1,7 @@ + + diff --git a/docs/images/nav-icons/annotation-kotlin.svg b/docs/images/nav-icons/annotation-kotlin.svg index 932f1d3..b90f508 100644 --- a/docs/images/nav-icons/annotation-kotlin.svg +++ b/docs/images/nav-icons/annotation-kotlin.svg @@ -1,3 +1,7 @@ + + diff --git a/docs/images/nav-icons/class-kotlin.svg b/docs/images/nav-icons/class-kotlin.svg index 46a21f6..797a242 100644 --- a/docs/images/nav-icons/class-kotlin.svg +++ b/docs/images/nav-icons/class-kotlin.svg @@ -1,3 +1,7 @@ + + diff --git a/docs/images/nav-icons/enum-kotlin.svg b/docs/images/nav-icons/enum-kotlin.svg index 4a85459..775a7cc 100644 --- a/docs/images/nav-icons/enum-kotlin.svg +++ b/docs/images/nav-icons/enum-kotlin.svg @@ -1,3 +1,7 @@ + + diff --git a/docs/images/nav-icons/field-value.svg b/docs/images/nav-icons/field-value.svg index 20449c9..2771ee5 100644 --- a/docs/images/nav-icons/field-value.svg +++ b/docs/images/nav-icons/field-value.svg @@ -1,3 +1,7 @@ + + diff --git a/docs/images/nav-icons/field-variable.svg b/docs/images/nav-icons/field-variable.svg index 3b07450..e2d2bbd 100644 --- a/docs/images/nav-icons/field-variable.svg +++ b/docs/images/nav-icons/field-variable.svg @@ -1,3 +1,7 @@ + + diff --git a/docs/images/nav-icons/interface-kotlin.svg b/docs/images/nav-icons/interface-kotlin.svg index bf07a14..5e16326 100644 --- a/docs/images/nav-icons/interface-kotlin.svg +++ b/docs/images/nav-icons/interface-kotlin.svg @@ -1,3 +1,7 @@ + + diff --git a/docs/images/nav-icons/object.svg b/docs/images/nav-icons/object.svg index 9f427de..31f0ee3 100644 --- a/docs/images/nav-icons/object.svg +++ b/docs/images/nav-icons/object.svg @@ -1,3 +1,7 @@ + + diff --git a/docs/images/nav-icons/typealias-kotlin.svg b/docs/images/nav-icons/typealias-kotlin.svg index 4795069..f4bb238 100644 --- a/docs/images/nav-icons/typealias-kotlin.svg +++ b/docs/images/nav-icons/typealias-kotlin.svg @@ -1,3 +1,7 @@ + + diff --git a/docs/images/theme-toggle.svg b/docs/images/theme-toggle.svg index dad3ff2..df86202 100644 --- a/docs/images/theme-toggle.svg +++ b/docs/images/theme-toggle.svg @@ -1,3 +1,7 @@ + + - \ No newline at end of file + diff --git a/docs/scripts/clipboard.js b/docs/scripts/clipboard.js index b00ce24..7a4f33c 100644 --- a/docs/scripts/clipboard.js +++ b/docs/scripts/clipboard.js @@ -1,3 +1,7 @@ +/* + * Copyright 2014-2023 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license. + */ + window.addEventListener('load', () => { document.querySelectorAll('span.copy-icon').forEach(element => { element.addEventListener('click', (el) => copyElementsContentToClipboard(element)); diff --git a/docs/scripts/navigation-loader.js b/docs/scripts/navigation-loader.js index 9246491..3df7ac8 100644 --- a/docs/scripts/navigation-loader.js +++ b/docs/scripts/navigation-loader.js @@ -1,3 +1,7 @@ +/* + * Copyright 2014-2023 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license. + */ + navigationPageText = fetch(pathToRoot + "navigation.html").then(response => response.text()) displayNavigationFromPage = () => { diff --git a/docs/scripts/platform-content-handler.js b/docs/scripts/platform-content-handler.js index 7c5e8af..8c4ca53 100644 --- a/docs/scripts/platform-content-handler.js +++ b/docs/scripts/platform-content-handler.js @@ -1,3 +1,7 @@ +/* + * Copyright 2014-2023 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license. + */ + filteringContext = { dependencies: {}, restrictedDependencies: [], diff --git a/docs/scripts/symbol-parameters-wrapper_deferred.js b/docs/scripts/symbol-parameters-wrapper_deferred.js index 248d0ab..7ecae7a 100644 --- a/docs/scripts/symbol-parameters-wrapper_deferred.js +++ b/docs/scripts/symbol-parameters-wrapper_deferred.js @@ -1,83 +1,64 @@ +/* + * Copyright 2014-2023 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license. + */ + // helps with some corner cases where starts working already, // but the signature is not yet long enough to be wrapped -const leftPaddingPx = 60 +(function() { + const leftPaddingPx = 60; -const symbolResizeObserver = new ResizeObserver(entries => { - entries.forEach(entry => { - const symbolElement = entry.target - symbolResizeObserver.unobserve(symbolElement) // only need it once, otherwise will be executed multiple times - wrapSymbolParameters(symbolElement); - }) -}); - -const wrapAllSymbolParameters = () => { - document.querySelectorAll("div.symbol").forEach(symbol => wrapSymbolParameters(symbol)) -} - -const wrapSymbolParameters = (symbol) => { - let parametersBlock = symbol.querySelector("span.parameters") - if (parametersBlock == null) { - return // nothing to wrap + function createNbspIndent() { + let indent = document.createElement("span"); + indent.append(document.createTextNode("\u00A0\u00A0\u00A0\u00A0")); + indent.classList.add("nbsp-indent"); + return indent; } - let symbolBlockWidth = symbol.clientWidth + function wrapSymbolParameters(entry) { + const symbol = entry.target; + const symbolBlockWidth = entry.borderBoxSize && entry.borderBoxSize[0] && entry.borderBoxSize[0].inlineSize; - // Even though the script is marked as `defer` and we wait for `DOMContentLoaded` event, - // it can happen that `symbolBlockWidth` is 0, indicating that something hasn't been loaded. - // In this case, just retry once all styles have been applied and it has been resized correctly. - if (symbolBlockWidth === 0) { - symbolResizeObserver.observe(symbol) - return + // Even though the script is marked as `defer` and we wait for `DOMContentLoaded` event, + // or if this block is a part of hidden tab, it can happen that `symbolBlockWidth` is 0, + // indicating that something hasn't been loaded. + // In this case, observer will be triggered onсe again when it will be ready. + if (symbolBlockWidth > 0) { + const node = symbol.querySelector(".parameters"); + + if (node) { + // if window resize happened and observer was triggered, reset previously wrapped + // parameters as they might not need wrapping anymore, and check again + node.classList.remove("wrapped"); + node.querySelectorAll(".parameter .nbsp-indent") + .forEach(indent => indent.remove()); + + const innerTextWidth = Array.from(symbol.children) + .filter(it => !it.classList.contains("block")) // blocks are usually on their own (like annotations), so ignore it + .map(it => it.getBoundingClientRect().width) + .reduce((a, b) => a + b, 0); + + // if signature text takes up more than a single line, wrap params for readability + if (innerTextWidth > (symbolBlockWidth - leftPaddingPx)) { + node.classList.add("wrapped"); + node.querySelectorAll(".parameter").forEach(param => { + // has to be a physical indent so that it can be copied. styles like + // paddings and `::before { content: " " }` do not work for that + param.prepend(createNbspIndent()); + }); + } + } + } } - let innerTextWidth = Array.from(symbol.children) - .filter(it => !it.classList.contains("block")) // blocks are usually on their own (like annotations), so ignore it - .map(it => it.getBoundingClientRect().width).reduce((a, b) => a + b, 0) + const symbolsObserver = new ResizeObserver(entries => entries.forEach(wrapSymbolParameters)); - // if signature text takes up more than a single line, wrap params for readability - let shouldWrapParams = innerTextWidth > (symbolBlockWidth - leftPaddingPx) - if (shouldWrapParams) { - parametersBlock.classList.add("wrapped") - parametersBlock.querySelectorAll("span.parameter").forEach(param => { - // has to be a physical indent so that it can be copied. styles like - // paddings and `::before { content: " " }` do not work for that - param.prepend(createNbspIndent()) - }) + function initHandlers() { + document.querySelectorAll("div.symbol").forEach(symbol => symbolsObserver.observe(symbol)); } -} -const createNbspIndent = () => { - let indent = document.createElement("span") - indent.append(document.createTextNode("\u00A0\u00A0\u00A0\u00A0")) - indent.classList.add("nbsp-indent") - return indent -} + if (document.readyState === 'loading') window.addEventListener('DOMContentLoaded', initHandlers); + else initHandlers(); -const resetAllSymbolParametersWrapping = () => { - document.querySelectorAll("div.symbol").forEach(symbol => resetSymbolParametersWrapping(symbol)) -} - -const resetSymbolParametersWrapping = (symbol) => { - let parameters = symbol.querySelector("span.parameters") - if (parameters != null) { - parameters.classList.remove("wrapped") - parameters.querySelectorAll("span.parameter").forEach(param => { - let indent = param.querySelector("span.nbsp-indent") - if (indent != null) indent.remove() - }) - } -} - -if (document.readyState === 'loading') { - window.addEventListener('DOMContentLoaded', () => { - wrapAllSymbolParameters() - }) -} else { - wrapAllSymbolParameters() -} - -window.onresize = event => { - // need to re-calculate if params need to be wrapped after resize - resetAllSymbolParametersWrapping() - wrapAllSymbolParameters() -} + // ToDo: Add `unobserve` if dokka will be SPA-like: + // https://github.com/w3c/csswg-drafts/issues/5155 +})(); diff --git a/docs/styles/font-jb-sans-auto.css b/docs/styles/font-jb-sans-auto.css index 95d8ef8..bdc6872 100644 --- a/docs/styles/font-jb-sans-auto.css +++ b/docs/styles/font-jb-sans-auto.css @@ -1,3 +1,7 @@ +/* + * Copyright 2014-2023 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license. + */ + /* Light weight */ @font-face { font-family: 'JetBrains Sans'; diff --git a/docs/styles/logo-styles.css b/docs/styles/logo-styles.css index f3846e8..69804e4 100644 --- a/docs/styles/logo-styles.css +++ b/docs/styles/logo-styles.css @@ -1,3 +1,7 @@ +/* + * Copyright 2014-2023 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license. + */ + :root { --dokka-logo-image-url: url('../images/logo-icon.svg'); --dokka-logo-height: 50px; diff --git a/docs/styles/main.css b/docs/styles/main.css index 5aa04a4..ebe1ce1 100644 --- a/docs/styles/main.css +++ b/docs/styles/main.css @@ -1,4 +1,6 @@ -#pages-search{cursor:pointer;border:none;border-radius:50%;background:transparent;fill:#fff;fill:var(--dark-mode-and-search-icon-color)}#pages-search:focus{outline:none}#pages-search:hover{background:var(--white-10)}.search,.search [data-test=ring-select],.search [data-test=ring-tooltip],.search [data-test=ring-select_focus],.search #pages-search{display:inline-block;padding:0;margin:0;font-size:0;line-height:0}.search-hotkey-popup{background-color:var(--background-color) !important;padding:4px}.popup-wrapper{min-width:calc(100% - 322px) !important;border:1px solid rgba(255,255,255,.2) !important;background-color:#27282c !important}.popup-wrapper [class^=filterWrapper]{border-bottom:1px solid rgba(255,255,255,.2)}.popup-wrapper input{color:rgba(255,255,255,.8) !important;font-weight:normal !important}.popup-wrapper span[data-test-custom=ring-select-popup-filter-icon]{color:#fff}.popup-wrapper button[data-test=ring-input-clear]{color:#fff !important}@media screen and (max-width: 759px){.popup-wrapper{min-width:100% !important}}.template-wrapper{display:grid;height:32px;grid-template-columns:auto auto}.template-wrapper strong{color:rgba(255,255,255,.8)}.template-wrapper span{color:rgba(255,255,255,.8);line-height:32px}.template-wrapper span.template-description{color:rgba(255,255,255,.6);justify-self:end}@media screen and (max-width: 759px){.template-wrapper{display:flex;flex-direction:column;height:auto}.template-wrapper span{line-height:unset}}.template-name{justify-self:start}[class^=fade]{display:none}[class*=hover]{background-color:rgba(255,255,255,.1) !important} +/*! + * Copyright 2014-2023 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license. + */#pages-search{cursor:pointer;border:none;border-radius:50%;background:transparent;fill:#fff;fill:var(--dark-mode-and-search-icon-color)}#pages-search:focus{outline:none}#pages-search:hover{background:var(--white-10)}.search,.search [data-test=ring-select],.search [data-test=ring-tooltip],.search [data-test=ring-select_focus],.search #pages-search{display:inline-block;padding:0;margin:0;font-size:0;line-height:0}.search-hotkey-popup{background-color:var(--background-color) !important;padding:4px}.popup-wrapper{min-width:calc(100% - 322px) !important;border:1px solid rgba(255,255,255,.2) !important;background-color:#27282c !important}.popup-wrapper [class^=filterWrapper]{border-bottom:1px solid rgba(255,255,255,.2)}.popup-wrapper input{color:rgba(255,255,255,.8) !important;font-weight:normal !important}.popup-wrapper span[data-test-custom=ring-select-popup-filter-icon]{color:#fff}.popup-wrapper button[data-test=ring-input-clear]{color:#fff !important}@media screen and (max-width: 759px){.popup-wrapper{min-width:100% !important}}.template-wrapper{display:grid;height:32px;grid-template-columns:auto auto}.template-wrapper strong{color:rgba(255,255,255,.8)}.template-wrapper span{color:rgba(255,255,255,.8);line-height:32px}.template-wrapper span.template-description{color:rgba(255,255,255,.6);justify-self:end}@media screen and (max-width: 759px){.template-wrapper{display:flex;flex-direction:column;height:auto}.template-wrapper span{line-height:unset}}.template-name{justify-self:start}[class^=fade]{display:none}[class*=hover]{background-color:rgba(255,255,255,.1) !important} /* stylelint-disable color-no-hex */ :root { @@ -113,6 +115,10 @@ --ring-alert-z-index: 6; } -html,.app-root{height:100%}.search-root{margin:0;padding:0;background:var(--ring-content-background-color);font-family:var(--ring-font-family);font-size:var(--ring-font-size);line-height:var(--ring-line-height)}.search-content{z-index:8} +/*! + * Copyright 2014-2023 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license. + *//*! + * Copyright 2014-2023 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license. + */html,.app-root{height:100%}.search-root{margin:0;padding:0;background:var(--ring-content-background-color);font-family:var(--ring-font-family);font-size:var(--ring-font-size);line-height:var(--ring-line-height)}.search-content{z-index:8} /*# sourceMappingURL=main.css.map*/ \ No newline at end of file diff --git a/docs/styles/prism.css b/docs/styles/prism.css index 4287f6d..2d3a091 100644 --- a/docs/styles/prism.css +++ b/docs/styles/prism.css @@ -1,3 +1,7 @@ +/* + * Copyright 2014-2023 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license. + */ + /* * Custom Dokka styles */ diff --git a/docs/styles/style.css b/docs/styles/style.css index 7f6e4b0..67a899a 100644 --- a/docs/styles/style.css +++ b/docs/styles/style.css @@ -1,3 +1,7 @@ +/* + * Copyright 2014-2023 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license. + */ + @import url('./font-jb-sans-auto.css'); @import url('https://fonts.googleapis.com/css?family=JetBrains+Mono'); @@ -1476,4 +1480,4 @@ has only one header, and the header text is the same as the tab name, so no poin */ .main-content[data-page-type="package"] .tabs-section-body h2 { display: none; -} \ No newline at end of file +}