Skip to content
This repository was archived by the owner on Jan 12, 2024. It is now read-only.

Commit ac5784a

Browse files
committed
[docs] Update documentation
1 parent e890d63 commit ac5784a

Some content is hidden

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

71 files changed

+71
-71
lines changed

docs/extensions-koin/dev.floofy.utils.koin/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -149,7 +149,7 @@ <h2 class="">Functions</h2>
149149
</div>
150150
</div>
151151
<div class="footer">
152-
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2023 Copyright</span><span class="pull-right"><span>Generated by </span><a href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
152+
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span class="pull-right"><span>Generated by </span><a href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
153153
</div>
154154
</div>
155155
</div>

docs/extensions-koin/dev.floofy.utils.koin/inject-or-null.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ <h1 class="cover"><span>inject</span><wbr><span>Or</span><wbr><span><span>Null</
6666
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":extensions-koin:dokkaHtmlPartial/main"><div class="symbol monospace"><span class="token keyword">inline </span><span class="token keyword">fun </span><span class="token operator">&lt;</span><span class="token keyword"></span><a href="inject-or-null.html">T</a><span class="token operator">&gt; </span><a href="inject-or-null.html"><span class="token function">injectOrNull</span></a><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.properties/-read-only-property/index.html">ReadOnlyProperty</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html">Any</a><span class="token operator">?</span><span class="token punctuation">, </span><span class="token keyword"></span><a href="inject-or-null.html">T</a><span class="token operator">?</span><span class="token operator">&gt;</span></div><p class="paragraph">Readonly property to get a reference of <a href="inject-or-null.html">T</a> or null if it wasn't found in the Koin application.</p></div></div>
6767
</div>
6868
<div class="footer">
69-
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2023 Copyright</span><span class="pull-right"><span>Generated by </span><a href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
69+
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span class="pull-right"><span>Generated by </span><a href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
7070
</div>
7171
</div>
7272
</div>

docs/extensions-koin/dev.floofy.utils.koin/inject.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ <h1 class="cover"><span><span>inject</span></span></h1>
6666
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":extensions-koin:dokkaHtmlPartial/main"><div class="symbol monospace"><span class="token keyword">inline </span><span class="token keyword">fun </span><span class="token operator">&lt;</span><span class="token keyword"></span><a href="inject.html">T</a><span class="token operator">&gt; </span><a href="inject.html"><span class="token function">inject</span></a><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.properties/-read-only-property/index.html">ReadOnlyProperty</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html">Any</a><span class="token operator">?</span><span class="token punctuation">, </span><span class="token keyword"></span><a href="inject.html">T</a><span class="token operator">&gt;</span></div><p class="paragraph">Readonly property to quickly get a reference of <a href="inject.html">T</a>.</p></div></div>
6767
</div>
6868
<div class="footer">
69-
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2023 Copyright</span><span class="pull-right"><span>Generated by </span><a href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
69+
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span class="pull-right"><span>Generated by </span><a href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
7070
</div>
7171
</div>
7272
</div>

docs/extensions-koin/dev.floofy.utils.koin/retrieve-all.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ <h1 class="cover"><span>retrieve</span><wbr><span><span>All</span></span></h1>
6666
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":extensions-koin:dokkaHtmlPartial/main"><div class="symbol monospace"><span class="token keyword">inline </span><span class="token keyword">fun </span><span class="token operator">&lt;</span><span class="token keyword"></span><a href="retrieve-all.html">T</a><span class="token operator">&gt; </span><span data-unresolved-link="org.koin.core.context/GlobalContext///PointingToDeclaration/">GlobalContext</span><span class="token punctuation">.</span><a href="retrieve-all.html"><span class="token function">retrieveAll</span></a><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html">List</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="retrieve-all.html">T</a><span class="token operator">&gt;</span></div><p class="paragraph">Returns a list of objects as <a href="retrieve-all.html">T</a> from the current Koin application.</p></div></div>
6767
</div>
6868
<div class="footer">
69-
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2023 Copyright</span><span class="pull-right"><span>Generated by </span><a href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
69+
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span class="pull-right"><span>Generated by </span><a href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
7070
</div>
7171
</div>
7272
</div>

docs/extensions-koin/dev.floofy.utils.koin/retrieve-or-null.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ <h1 class="cover"><span>retrieve</span><wbr><span>Or</span><wbr><span><span>Null
6666
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":extensions-koin:dokkaHtmlPartial/main"><div class="symbol monospace"><span class="token keyword">inline </span><span class="token keyword">fun </span><span class="token operator">&lt;</span><span class="token keyword"></span><a href="retrieve-or-null.html">T</a><span class="token operator">&gt; </span><span data-unresolved-link="org.koin.core.context/GlobalContext///PointingToDeclaration/">GlobalContext</span><span class="token punctuation">.</span><a href="retrieve-or-null.html"><span class="token function">retrieveOrNull</span></a><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator">: </span><a href="retrieve-or-null.html">T</a><span class="token operator">?</span></div><p class="paragraph">Simple method to return an object as <a href="retrieve-or-null.html">T</a> from the current Koin application or <code class="lang-kotlin">null</code> if it was never registered.</p></div></div>
6767
</div>
6868
<div class="footer">
69-
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2023 Copyright</span><span class="pull-right"><span>Generated by </span><a href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
69+
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span class="pull-right"><span>Generated by </span><a href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
7070
</div>
7171
</div>
7272
</div>

docs/extensions-koin/dev.floofy.utils.koin/retrieve.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ <h1 class="cover"><span><span>retrieve</span></span></h1>
6666
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":extensions-koin:dokkaHtmlPartial/main"><div class="symbol monospace"><span class="token keyword">inline </span><span class="token keyword">fun </span><span class="token operator">&lt;</span><span class="token keyword"></span><a href="retrieve.html">T</a><span class="token operator">&gt; </span><span data-unresolved-link="org.koin.core.context/GlobalContext///PointingToDeclaration/">GlobalContext</span><span class="token punctuation">.</span><a href="retrieve.html"><span class="token function">retrieve</span></a><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator">: </span><a href="retrieve.html">T</a></div><p class="paragraph">Simple method to return an object as <a href="retrieve.html">T</a> from the current Koin application</p></div></div>
6767
</div>
6868
<div class="footer">
69-
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2023 Copyright</span><span class="pull-right"><span>Generated by </span><a href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
69+
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span class="pull-right"><span>Generated by </span><a href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
7070
</div>
7171
</div>
7272
</div>

docs/extensions-koin/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ <h2 class="">Packages</h2>
8585
</div>
8686
</div>
8787
<div class="footer">
88-
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2023 Copyright</span><span class="pull-right"><span>Generated by </span><a href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
88+
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span class="pull-right"><span>Generated by </span><a href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
8989
</div>
9090
</div>
9191
</div>

docs/extensions-kotlin/dev.floofy.utils.kotlin.threading/create-thread-factory.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ <h1 class="cover"><span>create</span><wbr><span>Thread</span><wbr><span><span>Fa
6666
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":extensions-kotlin:dokkaHtmlPartial/main"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">fun </span><a href="create-thread-factory.html"><span class="token function">createThreadFactory</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">name<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token punctuation">, </span></span><span class="parameter ">priority<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a><span class="token operator">?</span><span class="token operator"> = </span>null<span class="token punctuation">, </span></span><span class="parameter ">threadGroup<span class="token operator">: </span><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/ThreadGroup.html">ThreadGroup</a><span class="token operator"> = </span>Thread.currentThread().threadGroup</span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/ThreadFactory.html">ThreadFactory</a></div><p class="paragraph">Creates a new <a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/ThreadFactory.html">ThreadFactory</a> object with a specified <a href="create-thread-factory.html">name</a>.</p><span class="kdoc-tag"><h4 class="">Return</h4><p class="paragraph">a new <a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/ThreadFactory.html">ThreadFactory</a> object.</p></span><h4 class="">Parameters</h4><div class="table"><div class="table-row" data-filterable-current=":extensions-kotlin:dokkaHtmlPartial/main" data-filterable-set=":extensions-kotlin:dokkaHtmlPartial/main"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span><span>name</span></span></u></div></span></div><div><div class="title"><p class="paragraph">The name of the thread factory.</p></div></div></div></div><div class="table-row" data-filterable-current=":extensions-kotlin:dokkaHtmlPartial/main" data-filterable-set=":extensions-kotlin:dokkaHtmlPartial/main"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span><span>priority</span></span></u></div></span></div><div><div class="title"><p class="paragraph">The priority to set</p></div></div></div></div><div class="table-row" data-filterable-current=":extensions-kotlin:dokkaHtmlPartial/main" data-filterable-set=":extensions-kotlin:dokkaHtmlPartial/main"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span>thread</span><wbr><span><span>Group</span></span></u></div></span></div><div><div class="title"><p class="paragraph">The thread group to use.</p></div></div></div></div></div></div></div>
6767
</div>
6868
<div class="footer">
69-
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2023 Copyright</span><span class="pull-right"><span>Generated by </span><a href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
69+
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span class="pull-right"><span>Generated by </span><a href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
7070
</div>
7171
</div>
7272
</div>

docs/extensions-kotlin/dev.floofy.utils.kotlin.threading/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@ <h2 class="">Functions</h2>
8989
</div>
9090
</div>
9191
<div class="footer">
92-
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2023 Copyright</span><span class="pull-right"><span>Generated by </span><a href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
92+
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span class="pull-right"><span>Generated by </span><a href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
9393
</div>
9494
</div>
9595
</div>

docs/extensions-kotlin/dev.floofy.utils.kotlin/do-format-time.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ <h1 class="cover"><span>do</span><wbr><span>Format</span><wbr><span><span>Time</
6666
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":extensions-kotlin:dokkaHtmlPartial/main"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">fun </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html">Long</a><span class="token punctuation">.</span><a href="do-format-time.html"><span class="token function">doFormatTime</span></a><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></div><p class="paragraph">Returns the humanized time of a nanosecond-precision time.</p></div></div>
6767
</div>
6868
<div class="footer">
69-
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2023 Copyright</span><span class="pull-right"><span>Generated by </span><a href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
69+
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span class="pull-right"><span>Generated by </span><a href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
7070
</div>
7171
</div>
7272
</div>

0 commit comments

Comments
 (0)