Skip to content

Commit 297fbd4

Browse files
junerverjunerver
committed
📝: update api documentation
1 parent 5e5b032 commit 297fbd4

File tree

76 files changed

+5652
-244
lines changed

Some content is hidden

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

76 files changed

+5652
-244
lines changed

‎docs/api/hooks/package-list

Lines changed: 65 additions & 6 deletions
Large diffs are not rendered by default.

‎docs/api/hooks/xyz.junerver.compose.hooks.useidle/index.html

Lines changed: 103 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,103 @@
1+
<!DOCTYPE html>
2+
<html class="no-js">
3+
<head>
4+
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
5+
<title>xyz.junerver.compose.hooks.useidle</title>
6+
<link href="../../images/logo-icon.svg" rel="icon" type="image/svg">
7+
<script>var pathToRoot = "../../";</script>
8+
<script>document.documentElement.classList.replace("no-js","js");</script>
9+
<script>const storage = localStorage.getItem("dokka-dark-mode")
10+
if (storage == null) {
11+
const osDarkSchemePreferred = window.matchMedia && window.matchMedia('(prefers-color-scheme: dark)').matches
12+
if (osDarkSchemePreferred === true) {
13+
document.getElementsByTagName("html")[0].classList.add("theme-dark")
14+
}
15+
} else {
16+
const savedDarkMode = JSON.parse(storage)
17+
if(savedDarkMode === true) {
18+
document.getElementsByTagName("html")[0].classList.add("theme-dark")
19+
}
20+
}
21+
</script>
22+
<script type="text/javascript" src="https://unpkg.com/kotlin-playground@1/dist/playground.min.js" async="async"></script>
23+
<script type="text/javascript" src="../../scripts/sourceset_dependencies.js" async="async"></script>
24+
<link href="../../styles/style.css" rel="Stylesheet">
25+
<link href="../../styles/main.css" rel="Stylesheet">
26+
<link href="../../styles/prism.css" rel="Stylesheet">
27+
<link href="../../styles/logo-styles.css" rel="Stylesheet">
28+
<link href="../../styles/font-jb-sans-auto.css" rel="Stylesheet">
29+
<script type="text/javascript" src="../../scripts/clipboard.js" async="async"></script>
30+
<script type="text/javascript" src="../../scripts/navigation-loader.js" async="async"></script>
31+
<script type="text/javascript" src="../../scripts/platform-content-handler.js" async="async"></script>
32+
<script type="text/javascript" src="../../scripts/main.js" defer="defer"></script>
33+
<script type="text/javascript" src="../../scripts/prism.js" async="async"></script>
34+
<script type="text/javascript" src="../../scripts/symbol-parameters-wrapper_deferred.js" defer="defer"></script>
35+
</head>
36+
<body>
37+
<div class="root">
38+
<nav class="navigation" id="navigation-wrapper">
39+
<div class="navigation--inner">
40+
<div class="navigation-title">
41+
<button class="menu-toggle" id="menu-toggle" type="button">toggle menu</button>
42+
<div class="library-name">
43+
<a class="library-name--link" href="../../index.html">
44+
hooks
45+
</a>
46+
</div>
47+
<div class="library-version">
48+
</div>
49+
</div>
50+
<div class="filter-section" id="filter-section">
51+
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":hooks:dokkaHtml/release">androidJvm</button>
52+
</div>
53+
</div>
54+
<div class="navigation-controls">
55+
<button class="navigation-controls--btn navigation-controls--theme" id="theme-toggle-button" type="button">switch theme</button>
56+
<div class="navigation-controls--btn navigation-controls--search" id="searchBar" role="button">search in API</div>
57+
</div>
58+
</nav>
59+
<div id="container">
60+
<div class="sidebar" id="leftColumn">
61+
<div class="sidebar--inner" id="sideMenu"></div>
62+
</div>
63+
<div id="main">
64+
<div class="main-content" data-page-type="package" id="content" pageIds="hooks::xyz.junerver.compose.hooks.useidle////PointingToDeclaration//1917587792">
65+
<div class="breadcrumbs"><a href="../../index.html">hooks</a><span class="delimiter">/</span><span class="current">xyz.junerver.compose.hooks.useidle</span></div>
66+
<div class="cover ">
67+
<h1 class="cover"><span><span>Package-level</span></span> <span><span>declarations</span></span></h1>
68+
</div>
69+
<div class="tabbedcontent">
70+
<div class="tabs-section" tabs-section="tabs-section"><button class="section-tab" data-active="" data-togglable="FUNCTION,EXTENSION_FUNCTION">Functions</button></div>
71+
<div class="tabs-section-body">
72+
<div data-togglable="FUNCTION">
73+
<h2 class="">Functions</h2>
74+
<div class="table"><a data-name="1915491189%2FFunctions%2F1917587792" anchor-label="useIdle" id="1915491189%2FFunctions%2F1917587792" data-filterable-set=":hooks:dokkaHtml/release"></a>
75+
<div class="table-row" data-filterable-current=":hooks:dokkaHtml/release" data-filterable-set=":hooks:dokkaHtml/release">
76+
<div class="main-subrow keyValue ">
77+
<div class=""><span class="inline-flex">
78+
<div><a href="use-idle.html"><span>use</span><wbr></wbr><span><span>Idle</span></span></a></div>
79+
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1915491189%2FFunctions%2F1917587792"></span>
80+
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
81+
</span></span></div>
82+
<div>
83+
<div class="title">
84+
<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"><div class="block"><div class="block"><span class="token annotation builtin">@</span><a href="https://developer.android.com/reference/kotlin/androidx/compose/runtime/Composable.html"><span class="token annotation builtin">Composable</span></a></div></div><span class="token keyword">fun </span><a href="use-idle.html"><span class="token function">useIdle</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">timeout<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.time/-duration/index.html">Duration</a><span class="token operator"> = </span>5.seconds</span></span><span class="token punctuation">)</span><span class="token operator">: </span><span data-unresolved-link="xyz.junerver.kotlin/Tuple2///PointingToDeclaration/">Tuple2</span><span class="token operator">&lt;</span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a><span class="token punctuation">, </span><span data-unresolved-link="kotlinx.datetime/Instant///PointingToDeclaration/">Instant</span><span class="token operator">&gt;</span></div></div></div>
85+
</div>
86+
</div>
87+
</div>
88+
</div>
89+
</div>
90+
</div>
91+
</div>
92+
</div>
93+
</div>
94+
<div class="footer">
95+
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span
96+
class="pull-right"><span>Generated by </span><a
97+
href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
98+
</div>
99+
</div>
100+
</div>
101+
</div>
102+
</body>
103+
</html>

‎docs/api/hooks/xyz.junerver.compose.hooks.useidle/use-idle.html

Lines changed: 80 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
1+
<!DOCTYPE html>
2+
<html class="no-js">
3+
<head>
4+
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
5+
<title>useIdle</title>
6+
<link href="../../images/logo-icon.svg" rel="icon" type="image/svg">
7+
<script>var pathToRoot = "../../";</script>
8+
<script>document.documentElement.classList.replace("no-js","js");</script>
9+
<script>const storage = localStorage.getItem("dokka-dark-mode")
10+
if (storage == null) {
11+
const osDarkSchemePreferred = window.matchMedia && window.matchMedia('(prefers-color-scheme: dark)').matches
12+
if (osDarkSchemePreferred === true) {
13+
document.getElementsByTagName("html")[0].classList.add("theme-dark")
14+
}
15+
} else {
16+
const savedDarkMode = JSON.parse(storage)
17+
if(savedDarkMode === true) {
18+
document.getElementsByTagName("html")[0].classList.add("theme-dark")
19+
}
20+
}
21+
</script>
22+
<script type="text/javascript" src="https://unpkg.com/kotlin-playground@1/dist/playground.min.js" async="async"></script>
23+
<script type="text/javascript" src="../../scripts/sourceset_dependencies.js" async="async"></script>
24+
<link href="../../styles/style.css" rel="Stylesheet">
25+
<link href="../../styles/main.css" rel="Stylesheet">
26+
<link href="../../styles/prism.css" rel="Stylesheet">
27+
<link href="../../styles/logo-styles.css" rel="Stylesheet">
28+
<link href="../../styles/font-jb-sans-auto.css" rel="Stylesheet">
29+
<script type="text/javascript" src="../../scripts/clipboard.js" async="async"></script>
30+
<script type="text/javascript" src="../../scripts/navigation-loader.js" async="async"></script>
31+
<script type="text/javascript" src="../../scripts/platform-content-handler.js" async="async"></script>
32+
<script type="text/javascript" src="../../scripts/main.js" defer="defer"></script>
33+
<script type="text/javascript" src="../../scripts/prism.js" async="async"></script>
34+
<script type="text/javascript" src="../../scripts/symbol-parameters-wrapper_deferred.js" defer="defer"></script>
35+
</head>
36+
<body>
37+
<div class="root">
38+
<nav class="navigation" id="navigation-wrapper">
39+
<div class="navigation--inner">
40+
<div class="navigation-title">
41+
<button class="menu-toggle" id="menu-toggle" type="button">toggle menu</button>
42+
<div class="library-name">
43+
<a class="library-name--link" href="../../index.html">
44+
hooks
45+
</a>
46+
</div>
47+
<div class="library-version">
48+
</div>
49+
</div>
50+
<div class="filter-section" id="filter-section">
51+
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":hooks:dokkaHtml/release">androidJvm</button>
52+
</div>
53+
</div>
54+
<div class="navigation-controls">
55+
<button class="navigation-controls--btn navigation-controls--theme" id="theme-toggle-button" type="button">switch theme</button>
56+
<div class="navigation-controls--btn navigation-controls--search" id="searchBar" role="button">search in API</div>
57+
</div>
58+
</nav>
59+
<div id="container">
60+
<div class="sidebar" id="leftColumn">
61+
<div class="sidebar--inner" id="sideMenu"></div>
62+
</div>
63+
<div id="main">
64+
<div class="main-content" data-page-type="member" id="content" pageIds="hooks::xyz.junerver.compose.hooks.useidle//useIdle/#kotlin.time.Duration/PointingToDeclaration//1917587792">
65+
<div class="breadcrumbs"><a href="../../index.html">hooks</a><span class="delimiter">/</span><a href="index.html">xyz.junerver.compose.hooks.useidle</a><span class="delimiter">/</span><span class="current">useIdle</span></div>
66+
<div class="cover ">
67+
<h1 class="cover"><span>use</span><wbr></wbr><span><span>Idle</span></span></h1>
68+
</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"><div class="block"><div class="block"><span class="token annotation builtin">@</span><a href="https://developer.android.com/reference/kotlin/androidx/compose/runtime/Composable.html"><span class="token annotation builtin">Composable</span></a></div></div><span class="token keyword">fun </span><a href="use-idle.html"><span class="token function">useIdle</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">timeout<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.time/-duration/index.html">Duration</a><span class="token operator"> = </span>5.seconds</span></span><span class="token punctuation">)</span><span class="token operator">: </span><span data-unresolved-link="xyz.junerver.kotlin/Tuple2///PointingToDeclaration/">Tuple2</span><span class="token operator">&lt;</span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a><span class="token punctuation">, </span><span data-unresolved-link="kotlinx.datetime/Instant///PointingToDeclaration/">Instant</span><span class="token operator">&gt;</span></div></div></div>
70+
</div>
71+
<div class="footer">
72+
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span
73+
class="pull-right"><span>Generated by </span><a
74+
href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
75+
</div>
76+
</div>
77+
</div>
78+
</div>
79+
</body>
80+
</html>

‎docs/api/hooks/xyz.junerver.compose.hooks.utils/-c-h-i-n-e-s-e_-a-b-b-r-e-v-i-a-t-e-d.html

Lines changed: 80 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
1+
<!DOCTYPE html>
2+
<html class="no-js">
3+
<head>
4+
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
5+
<title>CHINESE_ABBREVIATED</title>
6+
<link href="../../images/logo-icon.svg" rel="icon" type="image/svg">
7+
<script>var pathToRoot = "../../";</script>
8+
<script>document.documentElement.classList.replace("no-js","js");</script>
9+
<script>const storage = localStorage.getItem("dokka-dark-mode")
10+
if (storage == null) {
11+
const osDarkSchemePreferred = window.matchMedia && window.matchMedia('(prefers-color-scheme: dark)').matches
12+
if (osDarkSchemePreferred === true) {
13+
document.getElementsByTagName("html")[0].classList.add("theme-dark")
14+
}
15+
} else {
16+
const savedDarkMode = JSON.parse(storage)
17+
if(savedDarkMode === true) {
18+
document.getElementsByTagName("html")[0].classList.add("theme-dark")
19+
}
20+
}
21+
</script>
22+
<script type="text/javascript" src="https://unpkg.com/kotlin-playground@1/dist/playground.min.js" async="async"></script>
23+
<script type="text/javascript" src="../../scripts/sourceset_dependencies.js" async="async"></script>
24+
<link href="../../styles/style.css" rel="Stylesheet">
25+
<link href="../../styles/main.css" rel="Stylesheet">
26+
<link href="../../styles/prism.css" rel="Stylesheet">
27+
<link href="../../styles/logo-styles.css" rel="Stylesheet">
28+
<link href="../../styles/font-jb-sans-auto.css" rel="Stylesheet">
29+
<script type="text/javascript" src="../../scripts/clipboard.js" async="async"></script>
30+
<script type="text/javascript" src="../../scripts/navigation-loader.js" async="async"></script>
31+
<script type="text/javascript" src="../../scripts/platform-content-handler.js" async="async"></script>
32+
<script type="text/javascript" src="../../scripts/main.js" defer="defer"></script>
33+
<script type="text/javascript" src="../../scripts/prism.js" async="async"></script>
34+
<script type="text/javascript" src="../../scripts/symbol-parameters-wrapper_deferred.js" defer="defer"></script>
35+
</head>
36+
<body>
37+
<div class="root">
38+
<nav class="navigation" id="navigation-wrapper">
39+
<div class="navigation--inner">
40+
<div class="navigation-title">
41+
<button class="menu-toggle" id="menu-toggle" type="button">toggle menu</button>
42+
<div class="library-name">
43+
<a class="library-name--link" href="../../index.html">
44+
hooks
45+
</a>
46+
</div>
47+
<div class="library-version">
48+
</div>
49+
</div>
50+
<div class="filter-section" id="filter-section">
51+
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":hooks:dokkaHtml/release">androidJvm</button>
52+
</div>
53+
</div>
54+
<div class="navigation-controls">
55+
<button class="navigation-controls--btn navigation-controls--theme" id="theme-toggle-button" type="button">switch theme</button>
56+
<div class="navigation-controls--btn navigation-controls--search" id="searchBar" role="button">search in API</div>
57+
</div>
58+
</nav>
59+
<div id="container">
60+
<div class="sidebar" id="leftColumn">
61+
<div class="sidebar--inner" id="sideMenu"></div>
62+
</div>
63+
<div id="main">
64+
<div class="main-content" data-page-type="member" id="content" pageIds="hooks::xyz.junerver.compose.hooks.utils//CHINESE_ABBREVIATED/kotlinx.datetime.format.DayOfWeekNames.Companion#/PointingToDeclaration//1917587792">
65+
<div class="breadcrumbs"><a href="../../index.html">hooks</a><span class="delimiter">/</span><a href="index.html">xyz.junerver.compose.hooks.utils</a><span class="delimiter">/</span><span class="current">CHINESE_ABBREVIATED</span></div>
66+
<div class="cover ">
67+
<h1 class="cover"><span><span>CHINESE_ABBREVIATED</span></span></h1>
68+
</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">val </span><span data-unresolved-link="kotlinx.datetime.format/DayOfWeekNames.Companion///PointingToDeclaration/">DayOfWeekNames.Companion</span><span class="token punctuation">.</span><a href="-c-h-i-n-e-s-e_-a-b-b-r-e-v-i-a-t-e-d.html">CHINESE_ABBREVIATED</a><span class="token operator">: </span><span data-unresolved-link="kotlinx.datetime.format/DayOfWeekNames///PointingToDeclaration/">DayOfWeekNames</span></div></div></div>
70+
</div>
71+
<div class="footer">
72+
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span
73+
class="pull-right"><span>Generated by </span><a
74+
href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
75+
</div>
76+
</div>
77+
</div>
78+
</div>
79+
</body>
80+
</html>

0 commit comments

Comments
 (0)