Skip to content

Commit

Permalink
📝: update api documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
@junerver
junerver committed Nov 29, 2024
1 parent 36d78ff commit 7234748
Show file tree
Hide file tree
Showing 268 changed files with 33,854 additions and 1,067 deletions.
317 changes: 183 additions & 134 deletions docs/api/hooks2/package-list
View file

Large diffs are not rendered by default.

13 changes: 12 additions & 1 deletion docs/api/hooks2/xyz.junerver.compose.hooks.usedeviceinfo/-battery-info/-battery-info.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,18 @@ <h1 class="cover"><span>Battery</span><wbr></wbr><span><span>Info</span></span><
</div>
<div class="platform-hinted with-platform-tabs" data-platform-hinted="data-platform-hinted">
<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>
<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>
<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 operator"> = </span>-1<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
class="token operator"> = </span><span class="token boolean">false</span></span></span><span
class="token punctuation">)</span></div>
</div>
</div>
</div>
<div class="footer">
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span
Expand Down
44 changes: 41 additions & 3 deletions docs/api/hooks2/xyz.junerver.compose.hooks.usedeviceinfo/-battery-info/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,25 @@
<h1 class="cover"><span>Battery</span><wbr></wbr><span><span>Info</span></span></h1>
<div class="platform-hinted with-platform-tabs" data-platform-hinted="data-platform-hinted">
<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>
<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>
<div class="content sourceset-dependent-content" data-active="" data-togglable=":hooks:dokkaHtml/androidMain">
<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/Stable.html"><span
class="token annotation builtin">Stable</span></a></div>
</div>
<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 operator"> = </span>-1<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
class="token operator"> = </span><span class="token boolean">false</span></span></span><span
class="token punctuation">)</span></div>
</div>
</div>
</div>
<div class="tabbedcontent">
<div class="tabs-section" tabs-section="tabs-section"><button class="section-tab" data-active="" data-togglable="CONSTRUCTOR,TYPE,PROPERTY,FUNCTION">Members</button></div>
Expand All @@ -86,7 +104,20 @@ <h2 class="">Constructors</h2>
<div class="title">
<div class="platform-hinted with-platform-tabs" data-platform-hinted="data-platform-hinted">
<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>
<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>
<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 operator"> = </span>-1<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
class="token operator"> = </span><span
class="token boolean">false</span></span></span><span class="token punctuation">)</span>
</div>
</div>
</div>
</div>
</div>
</div>
Expand All @@ -107,7 +138,14 @@ <h2 class="">Properties</h2>
<div class="title">
<div class="platform-hinted with-platform-tabs" data-platform-hinted="data-platform-hinted">
<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>
<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>
<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><span
class="token operator"> = </span><span class="token boolean">false</span></div>
</div>
</div>
</div>
</div>
</div>
Expand Down
8 changes: 7 additions & 1 deletion docs/api/hooks2/xyz.junerver.compose.hooks.usedeviceinfo/-battery-info/is-charging.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,13 @@ <h1 class="cover"><span>is</span><wbr></wbr><span><span>Charging</span></span></
</div>
<div class="platform-hinted with-platform-tabs" data-platform-hinted="data-platform-hinted">
<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>
<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>
<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><span
class="token operator"> = </span><span class="token boolean">false</span></div>
</div>
</div>
</div>
<div class="footer">
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span
Expand Down
21 changes: 20 additions & 1 deletion docs/api/hooks2/xyz.junerver.compose.hooks.usedeviceinfo/-build-info/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,26 @@
<h1 class="cover"><span>Build</span><wbr></wbr><span><span>Info</span></span></h1>
<div class="platform-hinted with-platform-tabs" data-platform-hinted="data-platform-hinted">
<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>
<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>
<div class="content sourceset-dependent-content" data-active="" data-togglable=":hooks:dokkaHtml/androidMain">
<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/Stable.html"><span
class="token annotation builtin">Stable</span></a></div>
</div>
<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>
</div>
<div class="tabbedcontent">
<div class="tabs-section" tabs-section="tabs-section"><button class="section-tab" data-active="" data-togglable="CONSTRUCTOR,TYPE,PROPERTY,FUNCTION">Members</button></div>
Expand Down
24 changes: 23 additions & 1 deletion docs/api/hooks2/xyz.junerver.compose.hooks.usedeviceinfo/-screen-info/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,29 @@
<h1 class="cover"><span>Screen</span><wbr></wbr><span><span>Info</span></span></h1>
<div class="platform-hinted with-platform-tabs" data-platform-hinted="data-platform-hinted">
<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>
<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>
<div class="content sourceset-dependent-content" data-active="" data-togglable=":hooks:dokkaHtml/androidMain">
<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/Stable.html"><span
class="token annotation builtin">Stable</span></a></div>
</div>
<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>
</div>
<div class="tabbedcontent">
<div class="tabs-section" tabs-section="tabs-section"><button class="section-tab" data-active="" data-togglable="CONSTRUCTOR,TYPE,PROPERTY,FUNCTION">Members</button></div>
Expand Down
Loading

0 comments on commit 7234748

Please sign in to comment.