Skip to content

Commit 8682b87

Browse files
committed
📝: update api documentation
1 parent 7db630a commit 8682b87

File tree

20 files changed

+92
-127
lines changed

20 files changed

+92
-127
lines changed

docs/api/hooks/package-list

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,5 @@
11
$dokka.format:html-v1
22
$dokka.linkExtension:html
3-
$dokka.location:xyz.junerver.compose.hooks.ext////PointingToDeclaration/hooks/xyz.junerver.compose.hooks.ext/index.html
4-
$dokka.location:xyz.junerver.compose.hooks.ext//px/androidx.compose.ui.unit.Dp#/PointingToDeclaration/hooks/xyz.junerver.compose.hooks.ext/px.html
5-
$dokka.location:xyz.junerver.compose.hooks.ext//px2dp/kotlin.Int#/PointingToDeclaration/hooks/xyz.junerver.compose.hooks.ext/px2dp.html
6-
$dokka.location:xyz.junerver.compose.hooks.ext//toColor/kotlin.String#/PointingToDeclaration/hooks/xyz.junerver.compose.hooks.ext/to-color.html
73
$dokka.location:xyz.junerver.compose.hooks.useform////PointingToDeclaration/hooks/xyz.junerver.compose.hooks.useform/index.html
84
$dokka.location:xyz.junerver.compose.hooks.useform//Form/#xyz.junerver.compose.hooks.useform.FormInstance#kotlin.Function1[xyz.junerver.compose.hooks.useform.FormScope,kotlin.Unit]/PointingToDeclaration/hooks/xyz.junerver.compose.hooks.useform/-form.html
95
$dokka.location:xyz.junerver.compose.hooks.useform//useForm/#/PointingToDeclaration/hooks/xyz.junerver.compose.hooks.useform/use-form.html
@@ -384,7 +380,6 @@ $dokka.location:xyz.junerver.compose.hooks/UseNowOptions/UseNowOptions/#kotlin.t
384380
$dokka.location:xyz.junerver.compose.hooks/UseNowOptions/format/#/PointingToDeclaration/hooks/xyz.junerver.compose.hooks/-use-now-options/format.html
385381
$dokka.location:xyz.junerver.compose.hooks/UseNowOptions/interval/#/PointingToDeclaration/hooks/xyz.junerver.compose.hooks/-use-now-options/interval.html
386382
xyz.junerver.compose.hooks
387-
xyz.junerver.compose.hooks.ext
388383
xyz.junerver.compose.hooks.useform
389384
xyz.junerver.compose.hooks.usenetwork
390385
xyz.junerver.compose.hooks.useredux

docs/api/hooks/xyz.junerver.compose.hooks.userequest/-fetch-state/copy.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@
6666
<div class="cover ">
6767
<h1 class="cover"><span><span>copy</span></span></h1>
6868
</div>
69-
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":hooks:dokkaHtml/release"><div class="symbol monospace"><span class="token keyword">open </span><span class="token keyword">override </span><span class="token keyword">fun </span><a href="copy.html"><span class="token function">copy</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">needCopyMap<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-map/index.html">Map</a><span class="token operator">&lt;</span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token punctuation">, </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html">Any</a><span class="token operator">?</span><span class="token operator">&gt;</span><span class="token operator">?</span></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="index.html">FetchState</a><span class="token operator">&lt;</span><a href="index.html">TData</a><span class="token operator">&gt;</span></div><br><hr><div class="symbol monospace"><span class="token keyword">open </span><span class="token keyword">override </span><span class="token keyword">fun </span><a href="copy.html"><span class="token function">copy</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">that<span class="token operator">: </span><a href="index.html">FetchState</a><span class="token operator">&lt;</span><a href="index.html">TData</a><span class="token operator">&gt;</span><span class="token operator">?</span></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="index.html">FetchState</a><span class="token operator">&lt;</span><a href="index.html">TData</a><span class="token operator">&gt;</span></div><p class="paragraph"><a href="copy.html">copy</a>函数是为了通过<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/index.html">reduce</a>实现类似js中解构赋值覆盖的效果,注意实现时必须是<a href="copy.html">that</a>覆盖this: <code class="lang-kotlin">params = that.params ?: this.params,</code></p></div></div>
69+
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":hooks:dokkaHtml/release"><div class="symbol monospace"><span class="token keyword">open </span><span class="token keyword">override </span><span class="token keyword">fun </span><a href="copy.html"><span class="token function">copy</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">needCopyMap<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-map/index.html">Map</a><span class="token operator">&lt;</span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token punctuation">, </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html">Any</a><span class="token operator">?</span><span class="token operator">&gt;</span><span class="token operator">?</span></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="index.html">FetchState</a><span class="token operator">&lt;</span><a href="index.html">TData</a><span class="token operator">&gt;</span></div><div class="symbol monospace"><span class="token keyword">open </span><span class="token keyword">override </span><span class="token keyword">fun </span><a href="copy.html"><span class="token function">copy</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">that<span class="token operator">: </span><a href="index.html">FetchState</a><span class="token operator">&lt;</span><a href="index.html">TData</a><span class="token operator">&gt;</span><span class="token operator">?</span></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="index.html">FetchState</a><span class="token operator">&lt;</span><a href="index.html">TData</a><span class="token operator">&gt;</span></div></div></div>
7070
</div>
7171
<div class="footer">
7272
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span

docs/api/hooks/xyz.junerver.compose.hooks.userequest/-fetch-state/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -195,7 +195,7 @@ <h2 class="">Functions</h2>
195195
</span></span></div>
196196
<div>
197197
<div class="title">
198-
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":hooks:dokkaHtml/release"><div class="symbol monospace"><span class="token keyword">open </span><span class="token keyword">override </span><span class="token keyword">fun </span><a href="copy.html"><span class="token function">copy</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">needCopyMap<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-map/index.html">Map</a><span class="token operator">&lt;</span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token punctuation">, </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html">Any</a><span class="token operator">?</span><span class="token operator">&gt;</span><span class="token operator">?</span></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="index.html">FetchState</a><span class="token operator">&lt;</span><a href="index.html">TData</a><span class="token operator">&gt;</span></div><br><div class="symbol monospace"><span class="token keyword">open </span><span class="token keyword">override </span><span class="token keyword">fun </span><a href="copy.html"><span class="token function">copy</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">that<span class="token operator">: </span><a href="index.html">FetchState</a><span class="token operator">&lt;</span><a href="index.html">TData</a><span class="token operator">&gt;</span><span class="token operator">?</span></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="index.html">FetchState</a><span class="token operator">&lt;</span><a href="index.html">TData</a><span class="token operator">&gt;</span></div><div class="brief "><p class="paragraph"><a href="copy.html">copy</a>函数是为了通过<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/index.html">reduce</a>实现类似js中解构赋值覆盖的效果,注意实现时必须是<a href="copy.html">that</a>覆盖this: <code class="lang-kotlin">params = that.params ?: this.params,</code></p></div></div></div>
198+
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":hooks:dokkaHtml/release"><div class="symbol monospace"><span class="token keyword">open </span><span class="token keyword">override </span><span class="token keyword">fun </span><a href="copy.html"><span class="token function">copy</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">needCopyMap<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-map/index.html">Map</a><span class="token operator">&lt;</span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token punctuation">, </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html">Any</a><span class="token operator">?</span><span class="token operator">&gt;</span><span class="token operator">?</span></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="index.html">FetchState</a><span class="token operator">&lt;</span><a href="index.html">TData</a><span class="token operator">&gt;</span></div><div class="symbol monospace"><span class="token keyword">open </span><span class="token keyword">override </span><span class="token keyword">fun </span><a href="copy.html"><span class="token function">copy</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">that<span class="token operator">: </span><a href="index.html">FetchState</a><span class="token operator">&lt;</span><a href="index.html">TData</a><span class="token operator">&gt;</span><span class="token operator">?</span></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="index.html">FetchState</a><span class="token operator">&lt;</span><a href="index.html">TData</a><span class="token operator">&gt;</span></div></div></div>
199199
</div>
200200
</div>
201201
</div>

docs/api/hooks/xyz.junerver.compose.hooks.userequest/-on-before-return/copy.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@
6666
<div class="cover ">
6767
<h1 class="cover"><span><span>copy</span></span></h1>
6868
</div>
69-
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":hooks:dokkaHtml/release"><div class="symbol monospace"><span class="token keyword">open </span><span class="token keyword">override </span><span class="token keyword">fun </span><a href="copy.html"><span class="token function">copy</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">needCopyMap<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-map/index.html">Map</a><span class="token operator">&lt;</span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token punctuation">, </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html">Any</a><span class="token operator">?</span><span class="token operator">&gt;</span><span class="token operator">?</span></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="index.html">OnBeforeReturn</a><span class="token operator">&lt;</span><a href="index.html">TData</a><span class="token operator">&gt;</span></div><br><hr><div class="symbol monospace"><span class="token keyword">open </span><span class="token keyword">override </span><span class="token keyword">fun </span><a href="copy.html"><span class="token function">copy</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">that<span class="token operator">: </span><a href="index.html">OnBeforeReturn</a><span class="token operator">&lt;</span><a href="index.html">TData</a><span class="token operator">&gt;</span><span class="token operator">?</span></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="index.html">OnBeforeReturn</a><span class="token operator">&lt;</span><a href="index.html">TData</a><span class="token operator">&gt;</span></div><p class="paragraph"><a href="copy.html">copy</a>函数是为了通过<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/index.html">reduce</a>实现类似js中解构赋值覆盖的效果,注意实现时必须是<a href="copy.html">that</a>覆盖this: <code class="lang-kotlin">params = that.params ?: this.params,</code></p></div></div>
69+
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":hooks:dokkaHtml/release"><div class="symbol monospace"><span class="token keyword">open </span><span class="token keyword">override </span><span class="token keyword">fun </span><a href="copy.html"><span class="token function">copy</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">needCopyMap<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-map/index.html">Map</a><span class="token operator">&lt;</span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token punctuation">, </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html">Any</a><span class="token operator">?</span><span class="token operator">&gt;</span><span class="token operator">?</span></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="index.html">OnBeforeReturn</a><span class="token operator">&lt;</span><a href="index.html">TData</a><span class="token operator">&gt;</span></div><div class="symbol monospace"><span class="token keyword">open </span><span class="token keyword">override </span><span class="token keyword">fun </span><a href="copy.html"><span class="token function">copy</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">that<span class="token operator">: </span><a href="index.html">OnBeforeReturn</a><span class="token operator">&lt;</span><a href="index.html">TData</a><span class="token operator">&gt;</span><span class="token operator">?</span></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="index.html">OnBeforeReturn</a><span class="token operator">&lt;</span><a href="index.html">TData</a><span class="token operator">&gt;</span></div></div></div>
7070
</div>
7171
<div class="footer">
7272
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span

0 commit comments

Comments
 (0)