Skip to content

Commit 5ae24fb

Browse files
committed
use moduleName=kbox for nicer urls in docs
1 parent 29cab67 commit 5ae24fb

File tree

191 files changed

+1316
-1317
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

191 files changed

+1316
-1317
lines changed

docs/kdoc/index.html

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
<html class="no-js">
33
<head>
44
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
5-
<title>KBox</title>
5+
<title>kbox</title>
66
<link href="images/logo-icon.svg" rel="icon" type="image/svg">
77
<script>var pathToRoot = "";</script>
88
<script>document.documentElement.classList.replace("no-js","js");</script>
@@ -41,7 +41,7 @@
4141
<button class="menu-toggle" id="menu-toggle" type="button">toggle menu</button>
4242
<div class="library-name">
4343
<a class="library-name--link" href="index.html">
44-
KBox
44+
kbox
4545
</a>
4646
</div>
4747
<div class="library-version">
@@ -63,18 +63,18 @@
6363
<div class="sidebar--inner" id="sideMenu"></div>
6464
</div>
6565
<div id="main">
66-
<div class="main-content" id="content" pageIds="KBox::////PointingToDeclaration//-712551682">
66+
<div class="main-content" id="content" pageIds="kbox::////PointingToDeclaration//-712551682">
6767
<div class="breadcrumbs"></div>
6868
<div class="cover ">
69-
<h1 class="cover"><span><span>KBox</span></span></h1>
69+
<h1 class="cover"><span><span>kbox</span></span></h1>
7070
</div>
7171
<h2 class="">Packages</h2>
7272
<div class="table"><a data-name="-56380584%2FPackages%2F-712551682" anchor-label="ch.tutteli.kbox" id="-56380584%2FPackages%2F-712551682" data-filterable-set=":dokkaHtml/commonMain,:dokkaHtml/jsMain,:dokkaHtml/jvmMain"></a>
7373
<div class="table-row" data-filterable-current=":dokkaHtml/commonMain,:dokkaHtml/jsMain,:dokkaHtml/jvmMain" data-filterable-set=":dokkaHtml/commonMain,:dokkaHtml/jsMain,:dokkaHtml/jvmMain">
7474
<div>
7575
<div class="main-subrow ">
7676
<div class=""><span class="inline-flex">
77-
<div><a href="-k-box/ch.tutteli.kbox/index.html">ch.tutteli.kbox</a></div>
77+
<div><a href="kbox/ch.tutteli.kbox/index.html">ch.tutteli.kbox</a></div>
7878
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-56380584%2FPackages%2F-712551682"></span>
7979
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
8080
</span></span></div>

docs/kdoc/-k-box/ch.tutteli.kbox/-jvm-synchronized/index.html renamed to docs/kdoc/kbox/ch.tutteli.kbox/-jvm-synchronized/index.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@
4141
<button class="menu-toggle" id="menu-toggle" type="button">toggle menu</button>
4242
<div class="library-name">
4343
<a class="library-name--link" href="../../../index.html">
44-
KBox
44+
kbox
4545
</a>
4646
</div>
4747
<div class="library-version">
@@ -63,8 +63,8 @@
6363
<div class="sidebar--inner" id="sideMenu"></div>
6464
</div>
6565
<div id="main">
66-
<div class="main-content" data-page-type="classlike" id="content" pageIds="KBox::ch.tutteli.kbox/JvmSynchronized///PointingToDeclaration//-712551682">
67-
<div class="breadcrumbs"><a href="../../../index.html">KBox</a><span class="delimiter">/</span><a href="../index.html">ch.tutteli.kbox</a><span class="delimiter">/</span><span class="current">JvmSynchronized</span></div>
66+
<div class="main-content" data-page-type="classlike" id="content" pageIds="kbox::ch.tutteli.kbox/JvmSynchronized///PointingToDeclaration//-712551682">
67+
<div class="breadcrumbs"><a href="../../../index.html">kbox</a><span class="delimiter">/</span><a href="../index.html">ch.tutteli.kbox</a><span class="delimiter">/</span><span class="current">JvmSynchronized</span></div>
6868
<div class="cover ">
6969
<h1 class="cover"><span>Jvm</span><wbr></wbr><span><span>Synchronized</span></span></h1>
7070
<div class="platform-hinted with-platform-tabs" data-platform-hinted="data-platform-hinted">

docs/kdoc/-k-box/ch.tutteli.kbox/-peeking-iterator/-companion/index.html renamed to docs/kdoc/kbox/ch.tutteli.kbox/-peeking-iterator/-companion/index.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@
4141
<button class="menu-toggle" id="menu-toggle" type="button">toggle menu</button>
4242
<div class="library-name">
4343
<a class="library-name--link" href="../../../../index.html">
44-
KBox
44+
kbox
4545
</a>
4646
</div>
4747
<div class="library-version">
@@ -61,8 +61,8 @@
6161
<div class="sidebar--inner" id="sideMenu"></div>
6262
</div>
6363
<div id="main">
64-
<div class="main-content" data-page-type="classlike" id="content" pageIds="KBox::ch.tutteli.kbox/PeekingIterator.Companion///PointingToDeclaration//788909594">
65-
<div class="breadcrumbs"><a href="../../../../index.html">KBox</a><span class="delimiter">/</span><a href="../../index.html">ch.tutteli.kbox</a><span class="delimiter">/</span><a href="../index.html">PeekingIterator</a><span class="delimiter">/</span><span class="current">Companion</span></div>
64+
<div class="main-content" data-page-type="classlike" id="content" pageIds="kbox::ch.tutteli.kbox/PeekingIterator.Companion///PointingToDeclaration//788909594">
65+
<div class="breadcrumbs"><a href="../../../../index.html">kbox</a><span class="delimiter">/</span><a href="../../index.html">ch.tutteli.kbox</a><span class="delimiter">/</span><a href="../index.html">PeekingIterator</a><span class="delimiter">/</span><span class="current">Companion</span></div>
6666
<div class="cover ">
6767
<h1 class="cover"><span><span>Companion</span></span></h1>
6868
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/commonMain"><div class="symbol monospace"><span class="token keyword">object </span><a href="index.html">Companion</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/robstoll/kbox/tree/v3.2.0/src/commonMain/kotlin/ch/tutteli/kbox/PeekingIterator.kt#L16">source</a>)</span></span></div><p class="paragraph">Necessary so that extension methods can extend it.</p></div></div>

docs/kdoc/-k-box/ch.tutteli.kbox/-peeking-iterator/-companion/invoke.html renamed to docs/kdoc/kbox/ch.tutteli.kbox/-peeking-iterator/-companion/invoke.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@
4141
<button class="menu-toggle" id="menu-toggle" type="button">toggle menu</button>
4242
<div class="library-name">
4343
<a class="library-name--link" href="../../../../index.html">
44-
KBox
44+
kbox
4545
</a>
4646
</div>
4747
<div class="library-version">
@@ -61,8 +61,8 @@
6161
<div class="sidebar--inner" id="sideMenu"></div>
6262
</div>
6363
<div id="main">
64-
<div class="main-content" data-page-type="member" id="content" pageIds="KBox::ch.tutteli.kbox/PeekingIterator.Companion/invoke/#kotlin.collections.Iterator[TypeParam(bounds=[kotlin.Any])]/PointingToDeclaration//788909594">
65-
<div class="breadcrumbs"><a href="../../../../index.html">KBox</a><span class="delimiter">/</span><a href="../../index.html">ch.tutteli.kbox</a><span class="delimiter">/</span><a href="../index.html">PeekingIterator</a><span class="delimiter">/</span><a href="index.html">Companion</a><span class="delimiter">/</span><span class="current">invoke</span></div>
64+
<div class="main-content" data-page-type="member" id="content" pageIds="kbox::ch.tutteli.kbox/PeekingIterator.Companion/invoke/#kotlin.collections.Iterator[TypeParam(bounds=[kotlin.Any])]/PointingToDeclaration//788909594">
65+
<div class="breadcrumbs"><a href="../../../../index.html">kbox</a><span class="delimiter">/</span><a href="../../index.html">ch.tutteli.kbox</a><span class="delimiter">/</span><a href="../index.html">PeekingIterator</a><span class="delimiter">/</span><a href="index.html">Companion</a><span class="delimiter">/</span><span class="current">invoke</span></div>
6666
<div class="cover ">
6767
<h1 class="cover"><span><span>invoke</span></span></h1>
6868
</div>

docs/kdoc/-k-box/ch.tutteli.kbox/-peeking-iterator/index.html renamed to docs/kdoc/kbox/ch.tutteli.kbox/-peeking-iterator/index.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@
4141
<button class="menu-toggle" id="menu-toggle" type="button">toggle menu</button>
4242
<div class="library-name">
4343
<a class="library-name--link" href="../../../index.html">
44-
KBox
44+
kbox
4545
</a>
4646
</div>
4747
<div class="library-version">
@@ -61,8 +61,8 @@
6161
<div class="sidebar--inner" id="sideMenu"></div>
6262
</div>
6363
<div id="main">
64-
<div class="main-content" data-page-type="classlike" id="content" pageIds="KBox::ch.tutteli.kbox/PeekingIterator///PointingToDeclaration//788909594">
65-
<div class="breadcrumbs"><a href="../../../index.html">KBox</a><span class="delimiter">/</span><a href="../index.html">ch.tutteli.kbox</a><span class="delimiter">/</span><span class="current">PeekingIterator</span></div>
64+
<div class="main-content" data-page-type="classlike" id="content" pageIds="kbox::ch.tutteli.kbox/PeekingIterator///PointingToDeclaration//788909594">
65+
<div class="breadcrumbs"><a href="../../../index.html">kbox</a><span class="delimiter">/</span><a href="../index.html">ch.tutteli.kbox</a><span class="delimiter">/</span><span class="current">PeekingIterator</span></div>
6666
<div class="cover ">
6767
<h1 class="cover"><span>Peeking</span><wbr></wbr><span><span>Iterator</span></span></h1>
6868
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/commonMain"><div class="symbol monospace"><span class="token keyword">interface </span><a href="index.html">PeekingIterator</a><span class="token operator">&lt;</span><span class="token keyword">out </span><a href="index.html">T</a><span class="token operator"> : </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin-stdlib/kotlin/-any/index.html">Any</a><span class="token operator">&gt;</span> : <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin-stdlib/kotlin.collections/-iterator/index.html">Iterator</a><span class="token operator">&lt;</span><a href="index.html">T</a><span class="token operator">&gt; </span><span class="clearfix"><span class="floating-right">(<a href="https://github.com/robstoll/kbox/tree/v3.2.0/src/commonMain/kotlin/ch/tutteli/kbox/PeekingIterator.kt#L8">source</a>)</span></span></div><p class="paragraph">An <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin-stdlib/kotlin.collections/-iterator/index.html">Iterator</a> which provides the <a href="peek.html">peek</a> function in addition.</p></div></div>

docs/kdoc/-k-box/ch.tutteli.kbox/-peeking-iterator/peek.html renamed to docs/kdoc/kbox/ch.tutteli.kbox/-peeking-iterator/peek.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@
4141
<button class="menu-toggle" id="menu-toggle" type="button">toggle menu</button>
4242
<div class="library-name">
4343
<a class="library-name--link" href="../../../index.html">
44-
KBox
44+
kbox
4545
</a>
4646
</div>
4747
<div class="library-version">
@@ -61,8 +61,8 @@
6161
<div class="sidebar--inner" id="sideMenu"></div>
6262
</div>
6363
<div id="main">
64-
<div class="main-content" data-page-type="member" id="content" pageIds="KBox::ch.tutteli.kbox/PeekingIterator/peek/#/PointingToDeclaration//788909594">
65-
<div class="breadcrumbs"><a href="../../../index.html">KBox</a><span class="delimiter">/</span><a href="../index.html">ch.tutteli.kbox</a><span class="delimiter">/</span><a href="index.html">PeekingIterator</a><span class="delimiter">/</span><span class="current">peek</span></div>
64+
<div class="main-content" data-page-type="member" id="content" pageIds="kbox::ch.tutteli.kbox/PeekingIterator/peek/#/PointingToDeclaration//788909594">
65+
<div class="breadcrumbs"><a href="../../../index.html">kbox</a><span class="delimiter">/</span><a href="../index.html">ch.tutteli.kbox</a><span class="delimiter">/</span><a href="index.html">PeekingIterator</a><span class="delimiter">/</span><span class="current">peek</span></div>
6666
<div class="cover ">
6767
<h1 class="cover"><span><span>peek</span></span></h1>
6868
</div>
Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@
4141
<button class="menu-toggle" id="menu-toggle" type="button">toggle menu</button>
4242
<div class="library-name">
4343
<a class="library-name--link" href="../../../../index.html">
44-
KBox
44+
kbox
4545
</a>
4646
</div>
4747
<div class="library-version">
@@ -61,8 +61,8 @@
6161
<div class="sidebar--inner" id="sideMenu"></div>
6262
</div>
6363
<div id="main">
64-
<div class="main-content" data-page-type="classlike" id="content" pageIds="KBox::ch.tutteli.kbox/TraversalAlgorithmOption.BreadthFirst///PointingToDeclaration/{&quot;org.jetbrains.dokka.links.EnumEntryDRIExtra&quot;:{&quot;key&quot;:&quot;org.jetbrains.dokka.links.EnumEntryDRIExtra&quot;}}/788909594">
65-
<div class="breadcrumbs"><a href="../../../../index.html">KBox</a><span class="delimiter">/</span><a href="../../index.html">ch.tutteli.kbox</a><span class="delimiter">/</span><a href="../index.html">TraversalAlgorithmOption</a><span class="delimiter">/</span><span class="current">BreadthFirst</span></div>
64+
<div class="main-content" data-page-type="classlike" id="content" pageIds="kbox::ch.tutteli.kbox/TraversalAlgorithmOption.BreadthFirst///PointingToDeclaration/{&quot;org.jetbrains.dokka.links.EnumEntryDRIExtra&quot;:{&quot;key&quot;:&quot;org.jetbrains.dokka.links.EnumEntryDRIExtra&quot;}}/788909594">
65+
<div class="breadcrumbs"><a href="../../../../index.html">kbox</a><span class="delimiter">/</span><a href="../../index.html">ch.tutteli.kbox</a><span class="delimiter">/</span><a href="../index.html">TraversalAlgorithmOption</a><span class="delimiter">/</span><span class="current">BreadthFirst</span></div>
6666
<div class="cover ">
6767
<h1 class="cover"><span>Breadth</span><wbr></wbr><span><span>First</span></span></h1>
6868
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/commonMain"><div class="symbol monospace"><div class="block"><a href="index.html">BreadthFirst</a></div></div><p class="paragraph">Taking the tree as example, the resulting sequence contains the result in a breath first manner, i.e. if <code class="lang-kotlin">dropRoots = false</code> then the elements of the original sequence are returned first (if <code class="lang-kotlin">dropRoots] = true</code> then they are skipped/dropped), then the children of those elements, then the children of the children and so on.</p><span class="kdoc-tag"><h4 class="">Since</h4><p class="paragraph">1.1.0</p></span></div></div>

docs/kdoc/-k-box/ch.tutteli.kbox/-traversal-algorithm-option/-depth-first/index.html renamed to docs/kdoc/kbox/ch.tutteli.kbox/-traversal-algorithm-option/-depth-first/index.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@
4141
<button class="menu-toggle" id="menu-toggle" type="button">toggle menu</button>
4242
<div class="library-name">
4343
<a class="library-name--link" href="../../../../index.html">
44-
KBox
44+
kbox
4545
</a>
4646
</div>
4747
<div class="library-version">
@@ -61,8 +61,8 @@
6161
<div class="sidebar--inner" id="sideMenu"></div>
6262
</div>
6363
<div id="main">
64-
<div class="main-content" data-page-type="classlike" id="content" pageIds="KBox::ch.tutteli.kbox/TraversalAlgorithmOption.DepthFirst///PointingToDeclaration/{&quot;org.jetbrains.dokka.links.EnumEntryDRIExtra&quot;:{&quot;key&quot;:&quot;org.jetbrains.dokka.links.EnumEntryDRIExtra&quot;}}/788909594">
65-
<div class="breadcrumbs"><a href="../../../../index.html">KBox</a><span class="delimiter">/</span><a href="../../index.html">ch.tutteli.kbox</a><span class="delimiter">/</span><a href="../index.html">TraversalAlgorithmOption</a><span class="delimiter">/</span><span class="current">DepthFirst</span></div>
64+
<div class="main-content" data-page-type="classlike" id="content" pageIds="kbox::ch.tutteli.kbox/TraversalAlgorithmOption.DepthFirst///PointingToDeclaration/{&quot;org.jetbrains.dokka.links.EnumEntryDRIExtra&quot;:{&quot;key&quot;:&quot;org.jetbrains.dokka.links.EnumEntryDRIExtra&quot;}}/788909594">
65+
<div class="breadcrumbs"><a href="../../../../index.html">kbox</a><span class="delimiter">/</span><a href="../../index.html">ch.tutteli.kbox</a><span class="delimiter">/</span><a href="../index.html">TraversalAlgorithmOption</a><span class="delimiter">/</span><span class="current">DepthFirst</span></div>
6666
<div class="cover ">
6767
<h1 class="cover"><span>Depth</span><wbr></wbr><span><span>First</span></span></h1>
6868
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/commonMain"><div class="symbol monospace"><div class="block"><a href="index.html">DepthFirst</a></div></div><p class="paragraph">Taking the tree as example, the resulting sequence contains the result in a depth first manner, i.e. if <code class="lang-kotlin">dropRoots = false</code> then the first element of the original sequence is returned first (if <code class="lang-kotlin">dropRoots] = true</code> then this element is skipped/dropped). Next the first child of this first element is returned, then the first child of the first child etc. Once there is no first child (i.e. we reached a leaf of the tree) the sibling of this child is visited, and again the first child of this sibling etc.</p><span class="kdoc-tag"><h4 class="">Since</h4><p class="paragraph">1.1.0</p></span></div></div>

docs/kdoc/-k-box/ch.tutteli.kbox/-traversal-algorithm-option/entries.html renamed to docs/kdoc/kbox/ch.tutteli.kbox/-traversal-algorithm-option/entries.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@
4141
<button class="menu-toggle" id="menu-toggle" type="button">toggle menu</button>
4242
<div class="library-name">
4343
<a class="library-name--link" href="../../../index.html">
44-
KBox
44+
kbox
4545
</a>
4646
</div>
4747
<div class="library-version">
@@ -61,8 +61,8 @@
6161
<div class="sidebar--inner" id="sideMenu"></div>
6262
</div>
6363
<div id="main">
64-
<div class="main-content" data-page-type="member" id="content" pageIds="KBox::ch.tutteli.kbox/TraversalAlgorithmOption/entries/#/PointingToDeclaration//788909594">
65-
<div class="breadcrumbs"><a href="../../../index.html">KBox</a><span class="delimiter">/</span><a href="../index.html">ch.tutteli.kbox</a><span class="delimiter">/</span><a href="index.html">TraversalAlgorithmOption</a><span class="delimiter">/</span><span class="current">entries</span></div>
64+
<div class="main-content" data-page-type="member" id="content" pageIds="kbox::ch.tutteli.kbox/TraversalAlgorithmOption/entries/#/PointingToDeclaration//788909594">
65+
<div class="breadcrumbs"><a href="../../../index.html">kbox</a><span class="delimiter">/</span><a href="../index.html">ch.tutteli.kbox</a><span class="delimiter">/</span><a href="index.html">TraversalAlgorithmOption</a><span class="delimiter">/</span><span class="current">entries</span></div>
6666
<div class="cover ">
6767
<h1 class="cover"><span><span>entries</span></span></h1>
6868
</div>

0 commit comments

Comments
 (0)