Skip to content

Commit 7234748

Browse files
junerverjunerver
committed
📝: update api documentation
1 parent 36d78ff commit 7234748

268 files changed

Lines changed: 33854 additions & 1067 deletions

File tree

Some content is hidden

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

‎docs/api/hooks2/package-list‎

Lines changed: 183 additions & 134 deletions
Large diffs are not rendered by default.

‎docs/api/hooks2/xyz.junerver.compose.hooks.usedeviceinfo/-battery-info/-battery-info.html‎

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,18 @@ <h1 class="cover"><span>Battery</span><wbr></wbr><span><span>Info</span></span><
6868
</div>
6969
<div class="platform-hinted with-platform-tabs" data-platform-hinted="data-platform-hinted">
7070
<div class="platform-bookmarks-row" data-toggle-list="data-toggle-list"><button class="platform-bookmark" data-filterable-current=":hooks:dokkaHtml/androidMain" data-filterable-set=":hooks:dokkaHtml/androidMain" data-active="" data-toggle=":hooks:dokkaHtml/androidMain">android</button></div>
71-
<div class="content sourceset-dependent-content" data-active="" data-togglable=":hooks:dokkaHtml/androidMain"><div class="symbol monospace"><span class="token keyword">constructor</span><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">level<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a><span class="token punctuation">, </span></span><span class="parameter ">isCharging<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a></span></span><span class="token punctuation">)</span></div></div> </div>
71+
<div class="content sourceset-dependent-content" data-active="" data-togglable=":hooks:dokkaHtml/androidMain">
72+
<div class="symbol monospace"><span class="token keyword">constructor</span><span
73+
class="token punctuation">(</span><span class="parameters "><span class="parameter ">level<span
74+
class="token operator">: </span><a
75+
href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a><span
76+
class="token operator"> = </span>-1<span class="token punctuation">, </span></span><span
77+
class="parameter ">isCharging<span class="token operator">: </span><a
78+
href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a><span
79+
class="token operator"> = </span><span class="token boolean">false</span></span></span><span
80+
class="token punctuation">)</span></div>
81+
</div>
82+
</div>
7283
</div>
7384
<div class="footer">
7485
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span

‎docs/api/hooks2/xyz.junerver.compose.hooks.usedeviceinfo/-battery-info/index.html‎

Lines changed: 41 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,25 @@
6767
<h1 class="cover"><span>Battery</span><wbr></wbr><span><span>Info</span></span></h1>
6868
<div class="platform-hinted with-platform-tabs" data-platform-hinted="data-platform-hinted">
6969
<div class="platform-bookmarks-row" data-toggle-list="data-toggle-list"><button class="platform-bookmark" data-filterable-current=":hooks:dokkaHtml/androidMain" data-filterable-set=":hooks:dokkaHtml/androidMain" data-active="" data-toggle=":hooks:dokkaHtml/androidMain">android</button></div>
70-
<div class="content sourceset-dependent-content" data-active="" data-togglable=":hooks:dokkaHtml/androidMain"><div class="symbol monospace"><span class="token keyword">data </span><span class="token keyword">class </span><a href="index.html">BatteryInfo</a><span class="token punctuation">(</span><span class="parameters "><span class="parameter "><span class="token keyword">val </span>level<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a><span class="token punctuation">, </span></span><span class="parameter "><span class="token keyword">val </span>isCharging<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a></span></span><span class="token punctuation">)</span></div></div> </div>
70+
<div class="content sourceset-dependent-content" data-active="" data-togglable=":hooks:dokkaHtml/androidMain">
71+
<div class="symbol monospace">
72+
<div class="block">
73+
<div class="block"><span class="token annotation builtin">@</span><a
74+
href="https://developer.android.com/reference/kotlin/androidx/compose/runtime/Stable.html"><span
75+
class="token annotation builtin">Stable</span></a></div>
76+
</div>
77+
<span class="token keyword">data </span><span class="token keyword">class </span><a href="index.html">BatteryInfo</a><span
78+
class="token punctuation">(</span><span class="parameters "><span class="parameter "><span
79+
class="token keyword">val </span>level<span class="token operator">: </span><a
80+
href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a><span
81+
class="token operator"> = </span>-1<span class="token punctuation">, </span></span><span
82+
class="parameter "><span class="token keyword">val </span>isCharging<span
83+
class="token operator">: </span><a
84+
href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a><span
85+
class="token operator"> = </span><span class="token boolean">false</span></span></span><span
86+
class="token punctuation">)</span></div>
87+
</div>
88+
</div>
7189
</div>
7290
<div class="tabbedcontent">
7391
<div class="tabs-section" tabs-section="tabs-section"><button class="section-tab" data-active="" data-togglable="CONSTRUCTOR,TYPE,PROPERTY,FUNCTION">Members</button></div>
@@ -86,7 +104,20 @@ <h2 class="">Constructors</h2>
86104
<div class="title">
87105
<div class="platform-hinted with-platform-tabs" data-platform-hinted="data-platform-hinted">
88106
<div class="platform-bookmarks-row" data-toggle-list="data-toggle-list"><button class="platform-bookmark" data-filterable-current=":hooks:dokkaHtml/androidMain" data-filterable-set=":hooks:dokkaHtml/androidMain" data-active="" data-toggle=":hooks:dokkaHtml/androidMain">android</button></div>
89-
<div class="content sourceset-dependent-content" data-active="" data-togglable=":hooks:dokkaHtml/androidMain"><div class="symbol monospace"><span class="token keyword">constructor</span><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">level<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a><span class="token punctuation">, </span></span><span class="parameter ">isCharging<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a></span></span><span class="token punctuation">)</span></div></div> </div>
107+
<div class="content sourceset-dependent-content" data-active=""
108+
data-togglable=":hooks:dokkaHtml/androidMain">
109+
<div class="symbol monospace"><span class="token keyword">constructor</span><span
110+
class="token punctuation">(</span><span class="parameters "><span class="parameter ">level<span
111+
class="token operator">: </span><a
112+
href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a><span
113+
class="token operator"> = </span>-1<span class="token punctuation">, </span></span><span
114+
class="parameter ">isCharging<span class="token operator">: </span><a
115+
href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a><span
116+
class="token operator"> = </span><span
117+
class="token boolean">false</span></span></span><span class="token punctuation">)</span>
118+
</div>
119+
</div>
120+
</div>
90121
</div>
91122
</div>
92123
</div>
@@ -107,7 +138,14 @@ <h2 class="">Properties</h2>
107138
<div class="title">
108139
<div class="platform-hinted with-platform-tabs" data-platform-hinted="data-platform-hinted">
109140
<div class="platform-bookmarks-row" data-toggle-list="data-toggle-list"><button class="platform-bookmark" data-filterable-current=":hooks:dokkaHtml/androidMain" data-filterable-set=":hooks:dokkaHtml/androidMain" data-active="" data-toggle=":hooks:dokkaHtml/androidMain">android</button></div>
110-
<div class="content sourceset-dependent-content" data-active="" data-togglable=":hooks:dokkaHtml/androidMain"><div class="symbol monospace"><span class="token keyword">val </span><a href="is-charging.html">isCharging</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a></div></div> </div>
141+
<div class="content sourceset-dependent-content" data-active=""
142+
data-togglable=":hooks:dokkaHtml/androidMain">
143+
<div class="symbol monospace"><span class="token keyword">val </span><a
144+
href="is-charging.html">isCharging</a><span class="token operator">: </span><a
145+
href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a><span
146+
class="token operator"> = </span><span class="token boolean">false</span></div>
147+
</div>
148+
</div>
111149
</div>
112150
</div>
113151
</div>

‎docs/api/hooks2/xyz.junerver.compose.hooks.usedeviceinfo/-battery-info/is-charging.html‎

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,13 @@ <h1 class="cover"><span>is</span><wbr></wbr><span><span>Charging</span></span></
6868
</div>
6969
<div class="platform-hinted with-platform-tabs" data-platform-hinted="data-platform-hinted">
7070
<div class="platform-bookmarks-row" data-toggle-list="data-toggle-list"><button class="platform-bookmark" data-filterable-current=":hooks:dokkaHtml/androidMain" data-filterable-set=":hooks:dokkaHtml/androidMain" data-active="" data-toggle=":hooks:dokkaHtml/androidMain">android</button></div>
71-
<div class="content sourceset-dependent-content" data-active="" data-togglable=":hooks:dokkaHtml/androidMain"><div class="symbol monospace"><span class="token keyword">val </span><a href="is-charging.html">isCharging</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a></div></div> </div>
71+
<div class="content sourceset-dependent-content" data-active="" data-togglable=":hooks:dokkaHtml/androidMain">
72+
<div class="symbol monospace"><span class="token keyword">val </span><a href="is-charging.html">isCharging</a><span
73+
class="token operator">: </span><a
74+
href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a><span
75+
class="token operator"> = </span><span class="token boolean">false</span></div>
76+
</div>
77+
</div>
7278
</div>
7379
<div class="footer">
7480
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span

‎docs/api/hooks2/xyz.junerver.compose.hooks.usedeviceinfo/-build-info/index.html‎

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,26 @@
6767
<h1 class="cover"><span>Build</span><wbr></wbr><span><span>Info</span></span></h1>
6868
<div class="platform-hinted with-platform-tabs" data-platform-hinted="data-platform-hinted">
6969
<div class="platform-bookmarks-row" data-toggle-list="data-toggle-list"><button class="platform-bookmark" data-filterable-current=":hooks:dokkaHtml/androidMain" data-filterable-set=":hooks:dokkaHtml/androidMain" data-active="" data-toggle=":hooks:dokkaHtml/androidMain">android</button></div>
70-
<div class="content sourceset-dependent-content" data-active="" data-togglable=":hooks:dokkaHtml/androidMain"><div class="symbol monospace"><span class="token keyword">data </span><span class="token keyword">class </span><a href="index.html">BuildInfo</a><span class="token punctuation">(</span><span class="parameters "><span class="parameter "><span class="token keyword">val </span>brand<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 "><span class="token keyword">val </span>model<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 "><span class="token keyword">val </span>release<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></span></span><span class="token punctuation">)</span></div></div> </div>
70+
<div class="content sourceset-dependent-content" data-active="" data-togglable=":hooks:dokkaHtml/androidMain">
71+
<div class="symbol monospace">
72+
<div class="block">
73+
<div class="block"><span class="token annotation builtin">@</span><a
74+
href="https://developer.android.com/reference/kotlin/androidx/compose/runtime/Stable.html"><span
75+
class="token annotation builtin">Stable</span></a></div>
76+
</div>
77+
<span class="token keyword">data </span><span class="token keyword">class </span><a href="index.html">BuildInfo</a><span
78+
class="token punctuation">(</span><span class="parameters "><span class="parameter "><span
79+
class="token keyword">val </span>brand<span class="token operator">: </span><a
80+
href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span
81+
class="token punctuation">, </span></span><span class="parameter "><span
82+
class="token keyword">val </span>model<span class="token operator">: </span><a
83+
href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span
84+
class="token punctuation">, </span></span><span class="parameter "><span
85+
class="token keyword">val </span>release<span class="token operator">: </span><a
86+
href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></span></span><span
87+
class="token punctuation">)</span></div>
88+
</div>
89+
</div>
7190
</div>
7291
<div class="tabbedcontent">
7392
<div class="tabs-section" tabs-section="tabs-section"><button class="section-tab" data-active="" data-togglable="CONSTRUCTOR,TYPE,PROPERTY,FUNCTION">Members</button></div>

‎docs/api/hooks2/xyz.junerver.compose.hooks.usedeviceinfo/-screen-info/index.html‎

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,29 @@
6767
<h1 class="cover"><span>Screen</span><wbr></wbr><span><span>Info</span></span></h1>
6868
<div class="platform-hinted with-platform-tabs" data-platform-hinted="data-platform-hinted">
6969
<div class="platform-bookmarks-row" data-toggle-list="data-toggle-list"><button class="platform-bookmark" data-filterable-current=":hooks:dokkaHtml/androidMain" data-filterable-set=":hooks:dokkaHtml/androidMain" data-active="" data-toggle=":hooks:dokkaHtml/androidMain">android</button></div>
70-
<div class="content sourceset-dependent-content" data-active="" data-togglable=":hooks:dokkaHtml/androidMain"><div class="symbol monospace"><span class="token keyword">data </span><span class="token keyword">class </span><a href="index.html">ScreenInfo</a><span class="token punctuation">(</span><span class="parameters "><span class="parameter "><span class="token keyword">val </span>screenDp<span class="token operator">: </span><a href="https://developer.android.com/reference/kotlin/androidx/compose/ui/unit/IntSize.html">IntSize</a><span class="token punctuation">, </span></span><span class="parameter "><span class="token keyword">val </span>screenPx<span class="token operator">: </span><a href="https://developer.android.com/reference/kotlin/androidx/compose/ui/unit/IntSize.html">IntSize</a><span class="token punctuation">, </span></span><span class="parameter "><span class="token keyword">val </span>density<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-float/index.html">Float</a><span class="token punctuation">, </span></span><span class="parameter "><span class="token keyword">val </span>isLandscape<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a></span></span><span class="token punctuation">)</span></div></div> </div>
70+
<div class="content sourceset-dependent-content" data-active="" data-togglable=":hooks:dokkaHtml/androidMain">
71+
<div class="symbol monospace">
72+
<div class="block">
73+
<div class="block"><span class="token annotation builtin">@</span><a
74+
href="https://developer.android.com/reference/kotlin/androidx/compose/runtime/Stable.html"><span
75+
class="token annotation builtin">Stable</span></a></div>
76+
</div>
77+
<span class="token keyword">data </span><span class="token keyword">class </span><a href="index.html">ScreenInfo</a><span
78+
class="token punctuation">(</span><span class="parameters "><span class="parameter "><span
79+
class="token keyword">val </span>screenDp<span class="token operator">: </span><a
80+
href="https://developer.android.com/reference/kotlin/androidx/compose/ui/unit/IntSize.html">IntSize</a><span
81+
class="token punctuation">, </span></span><span class="parameter "><span
82+
class="token keyword">val </span>screenPx<span class="token operator">: </span><a
83+
href="https://developer.android.com/reference/kotlin/androidx/compose/ui/unit/IntSize.html">IntSize</a><span
84+
class="token punctuation">, </span></span><span class="parameter "><span
85+
class="token keyword">val </span>density<span class="token operator">: </span><a
86+
href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-float/index.html">Float</a><span
87+
class="token punctuation">, </span></span><span class="parameter "><span
88+
class="token keyword">val </span>isLandscape<span class="token operator">: </span><a
89+
href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a></span></span><span
90+
class="token punctuation">)</span></div>
91+
</div>
92+
</div>
7193
</div>
7294
<div class="tabbedcontent">
7395
<div class="tabs-section" tabs-section="tabs-section"><button class="section-tab" data-active="" data-togglable="CONSTRUCTOR,TYPE,PROPERTY,FUNCTION">Members</button></div>

0 commit comments

Comments
 (0)