From c166c75b98475651869b3ef030c32488a57d3276 Mon Sep 17 00:00:00 2001 From: Tpay Auto Commit Date: Wed, 21 Jan 2026 15:22:56 +0000 Subject: [PATCH] Update docs --- docs/images/anchor-copy-button.svg | 8 -- docs/images/arrow_down.svg | 3 - docs/images/copy-successful-icon.svg | 5 -- docs/images/footer-go-to-link.svg | 4 - .../nav-icons/abstract-class-kotlin.svg | 33 -------- docs/images/nav-icons/abstract-class.svg | 25 ------ docs/images/nav-icons/annotation-kotlin.svg | 14 ---- docs/images/nav-icons/annotation.svg | 10 --- docs/images/nav-icons/class-kotlin.svg | 14 ---- docs/images/nav-icons/class.svg | 10 --- docs/images/nav-icons/enum-kotlin.svg | 13 --- docs/images/nav-icons/enum.svg | 10 --- docs/images/nav-icons/exception-class.svg | 8 -- docs/images/nav-icons/field-value.svg | 8 -- docs/images/nav-icons/field-variable.svg | 9 -- docs/images/nav-icons/function.svg | 10 --- docs/images/nav-icons/interface-kotlin.svg | 13 --- docs/images/nav-icons/interface.svg | 10 --- docs/images/nav-icons/object.svg | 14 ---- docs/scripts/clipboard.js | 52 ------------ .../symbol-parameters-wrapper_deferred.js | 83 ------------------- docs/styles/jetbrains-mono.css | 17 ---- 22 files changed, 373 deletions(-) delete mode 100644 docs/images/anchor-copy-button.svg delete mode 100644 docs/images/arrow_down.svg delete mode 100644 docs/images/copy-successful-icon.svg delete mode 100644 docs/images/footer-go-to-link.svg delete mode 100644 docs/images/nav-icons/abstract-class-kotlin.svg delete mode 100644 docs/images/nav-icons/abstract-class.svg delete mode 100644 docs/images/nav-icons/annotation-kotlin.svg delete mode 100644 docs/images/nav-icons/annotation.svg delete mode 100644 docs/images/nav-icons/class-kotlin.svg delete mode 100644 docs/images/nav-icons/class.svg delete mode 100644 docs/images/nav-icons/enum-kotlin.svg delete mode 100644 docs/images/nav-icons/enum.svg delete mode 100644 docs/images/nav-icons/exception-class.svg delete mode 100644 docs/images/nav-icons/field-value.svg delete mode 100644 docs/images/nav-icons/field-variable.svg delete mode 100644 docs/images/nav-icons/function.svg delete mode 100644 docs/images/nav-icons/interface-kotlin.svg delete mode 100644 docs/images/nav-icons/interface.svg delete mode 100644 docs/images/nav-icons/object.svg delete mode 100644 docs/scripts/clipboard.js delete mode 100644 docs/scripts/symbol-parameters-wrapper_deferred.js delete mode 100644 docs/styles/jetbrains-mono.css diff --git a/docs/images/anchor-copy-button.svg b/docs/images/anchor-copy-button.svg deleted file mode 100644 index 4d2e62a..0000000 --- a/docs/images/anchor-copy-button.svg +++ /dev/null @@ -1,8 +0,0 @@ - - - - diff --git a/docs/images/arrow_down.svg b/docs/images/arrow_down.svg deleted file mode 100644 index 8372309..0000000 --- a/docs/images/arrow_down.svg +++ /dev/null @@ -1,3 +0,0 @@ - - - diff --git a/docs/images/copy-successful-icon.svg b/docs/images/copy-successful-icon.svg deleted file mode 100644 index bb8baeb..0000000 --- a/docs/images/copy-successful-icon.svg +++ /dev/null @@ -1,5 +0,0 @@ - - - diff --git a/docs/images/footer-go-to-link.svg b/docs/images/footer-go-to-link.svg deleted file mode 100644 index a907e38..0000000 --- a/docs/images/footer-go-to-link.svg +++ /dev/null @@ -1,4 +0,0 @@ - - - diff --git a/docs/images/nav-icons/abstract-class-kotlin.svg b/docs/images/nav-icons/abstract-class-kotlin.svg deleted file mode 100644 index a62ca49..0000000 --- a/docs/images/nav-icons/abstract-class-kotlin.svg +++ /dev/null @@ -1,33 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/images/nav-icons/abstract-class.svg b/docs/images/nav-icons/abstract-class.svg deleted file mode 100644 index 6e428a6..0000000 --- a/docs/images/nav-icons/abstract-class.svg +++ /dev/null @@ -1,25 +0,0 @@ - - - - - - - - - - - - - - - - - - - - diff --git a/docs/images/nav-icons/annotation-kotlin.svg b/docs/images/nav-icons/annotation-kotlin.svg deleted file mode 100644 index 8551707..0000000 --- a/docs/images/nav-icons/annotation-kotlin.svg +++ /dev/null @@ -1,14 +0,0 @@ - - - - - - - - - diff --git a/docs/images/nav-icons/annotation.svg b/docs/images/nav-icons/annotation.svg deleted file mode 100644 index ef2c563..0000000 --- a/docs/images/nav-icons/annotation.svg +++ /dev/null @@ -1,10 +0,0 @@ - - - - - - - diff --git a/docs/images/nav-icons/class-kotlin.svg b/docs/images/nav-icons/class-kotlin.svg deleted file mode 100644 index defdfb9..0000000 --- a/docs/images/nav-icons/class-kotlin.svg +++ /dev/null @@ -1,14 +0,0 @@ - - - - - - - - - diff --git a/docs/images/nav-icons/class.svg b/docs/images/nav-icons/class.svg deleted file mode 100644 index 539cb1a..0000000 --- a/docs/images/nav-icons/class.svg +++ /dev/null @@ -1,10 +0,0 @@ - - - - - - - diff --git a/docs/images/nav-icons/enum-kotlin.svg b/docs/images/nav-icons/enum-kotlin.svg deleted file mode 100644 index 45fe6bf..0000000 --- a/docs/images/nav-icons/enum-kotlin.svg +++ /dev/null @@ -1,13 +0,0 @@ - - - - - - - - - diff --git a/docs/images/nav-icons/enum.svg b/docs/images/nav-icons/enum.svg deleted file mode 100644 index 618b711..0000000 --- a/docs/images/nav-icons/enum.svg +++ /dev/null @@ -1,10 +0,0 @@ - - - - - - - diff --git a/docs/images/nav-icons/exception-class.svg b/docs/images/nav-icons/exception-class.svg deleted file mode 100644 index 5dbf65b..0000000 --- a/docs/images/nav-icons/exception-class.svg +++ /dev/null @@ -1,8 +0,0 @@ - - - - - - - diff --git a/docs/images/nav-icons/field-value.svg b/docs/images/nav-icons/field-value.svg deleted file mode 100644 index a8f0ae7..0000000 --- a/docs/images/nav-icons/field-value.svg +++ /dev/null @@ -1,8 +0,0 @@ - - - - - - diff --git a/docs/images/nav-icons/field-variable.svg b/docs/images/nav-icons/field-variable.svg deleted file mode 100644 index 62ad5c5..0000000 --- a/docs/images/nav-icons/field-variable.svg +++ /dev/null @@ -1,9 +0,0 @@ - - - - - - diff --git a/docs/images/nav-icons/function.svg b/docs/images/nav-icons/function.svg deleted file mode 100644 index 5688d27..0000000 --- a/docs/images/nav-icons/function.svg +++ /dev/null @@ -1,10 +0,0 @@ - - - - - - - diff --git a/docs/images/nav-icons/interface-kotlin.svg b/docs/images/nav-icons/interface-kotlin.svg deleted file mode 100644 index fce5fa7..0000000 --- a/docs/images/nav-icons/interface-kotlin.svg +++ /dev/null @@ -1,13 +0,0 @@ - - - - - - - - - diff --git a/docs/images/nav-icons/interface.svg b/docs/images/nav-icons/interface.svg deleted file mode 100644 index 67ca4e3..0000000 --- a/docs/images/nav-icons/interface.svg +++ /dev/null @@ -1,10 +0,0 @@ - - - - - - - diff --git a/docs/images/nav-icons/object.svg b/docs/images/nav-icons/object.svg deleted file mode 100644 index 7a037dc..0000000 --- a/docs/images/nav-icons/object.svg +++ /dev/null @@ -1,14 +0,0 @@ - - - - - - - - - diff --git a/docs/scripts/clipboard.js b/docs/scripts/clipboard.js deleted file mode 100644 index b00ce24..0000000 --- a/docs/scripts/clipboard.js +++ /dev/null @@ -1,52 +0,0 @@ -window.addEventListener('load', () => { - document.querySelectorAll('span.copy-icon').forEach(element => { - element.addEventListener('click', (el) => copyElementsContentToClipboard(element)); - }) - - document.querySelectorAll('span.anchor-icon').forEach(element => { - element.addEventListener('click', (el) => { - if(element.hasAttribute('pointing-to')){ - const location = hrefWithoutCurrentlyUsedAnchor() + '#' + element.getAttribute('pointing-to') - copyTextToClipboard(element, location) - } - }); - }) -}) - -const copyElementsContentToClipboard = (element) => { - const selection = window.getSelection(); - const range = document.createRange(); - range.selectNodeContents(element.parentNode.parentNode); - selection.removeAllRanges(); - selection.addRange(range); - - copyAndShowPopup(element, () => selection.removeAllRanges()) -} - -const copyTextToClipboard = (element, text) => { - var textarea = document.createElement("textarea"); - textarea.textContent = text; - textarea.style.position = "fixed"; - document.body.appendChild(textarea); - textarea.select(); - - copyAndShowPopup(element, () => document.body.removeChild(textarea)) -} - -const copyAndShowPopup = (element, after) => { - try { - document.execCommand('copy'); - element.nextElementSibling.classList.add('active-popup'); - setTimeout(() => { - element.nextElementSibling.classList.remove('active-popup'); - }, 1200); - } catch (e) { - console.error('Failed to write to clipboard:', e) - } - finally { - if(after) after() - } -} - -const hrefWithoutCurrentlyUsedAnchor = () => window.location.href.split('#')[0] - diff --git a/docs/scripts/symbol-parameters-wrapper_deferred.js b/docs/scripts/symbol-parameters-wrapper_deferred.js deleted file mode 100644 index 248d0ab..0000000 --- a/docs/scripts/symbol-parameters-wrapper_deferred.js +++ /dev/null @@ -1,83 +0,0 @@ -// helps with some corner cases where starts working already, -// but the signature is not yet long enough to be wrapped -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 - } - - let symbolBlockWidth = symbol.clientWidth - - // 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 - } - - 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) - - // 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()) - }) - } -} - -const createNbspIndent = () => { - let indent = document.createElement("span") - indent.append(document.createTextNode("\u00A0\u00A0\u00A0\u00A0")) - indent.classList.add("nbsp-indent") - return indent -} - -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() -} diff --git a/docs/styles/jetbrains-mono.css b/docs/styles/jetbrains-mono.css deleted file mode 100644 index 9a0f06f..0000000 --- a/docs/styles/jetbrains-mono.css +++ /dev/null @@ -1,17 +0,0 @@ -@font-face{ - font-family: 'JetBrains Mono'; - src: url('https://raw.githubusercontent.com/JetBrains/JetBrainsMono/master/fonts/web/JetBrainsMono-Regular.eot') format('embedded-opentype'), - url('https://raw.githubusercontent.com/JetBrains/JetBrainsMono/master/fonts/webfonts/JetBrainsMono-Regular.woff2') format('woff2'), - url('https://raw.githubusercontent.com/JetBrains/JetBrainsMono/master/fonts/ttf/JetBrainsMono-Regular.ttf') format('truetype'); - font-weight: normal; - font-style: normal; -} - -@font-face{ - font-family: 'JetBrains Mono'; - src: url('https://raw.githubusercontent.com/JetBrains/JetBrainsMono/master/fonts/web/JetBrainsMono-Bold.eot') format('embedded-opentype'), - url('https://raw.githubusercontent.com/JetBrains/JetBrainsMono/master/fonts/webfonts/JetBrainsMono-Bold.woff2') format('woff2'), - url('https://raw.githubusercontent.com/JetBrains/JetBrainsMono/master/fonts/ttf/JetBrainsMono-Bold.ttf') format('truetype'); - font-weight: bold; - font-style: bold; -} \ No newline at end of file