star/KSpigot
1
0
Fork 0
Code Pull Requests Packages Activity

Update dokka docs

Browse Source
This commit is contained in:
Jakob K
2021-05-15 22:14:07 +02:00
parent 7fa3ea0fab
commit 249e074a11
1090 changed files with 5647 additions and 9045 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
docs/-k-spigot/net.axay.kspigot.config/k-spigot-json-config.html
View File

@@ -13,7 +13,7 @@
</div>
<div id="main">
<div id="leftToggler"><span class="icon-toggler"></span></div>
<script type="text/javascript" src="../../scripts/main.js"></script> <div class="main-content" id="content" pageIds="KSpigot::net.axay.kspigot.config//kSpigotJsonConfig/#java.io.File#kotlin.Boolean#kotlin.Function0[TypeParam(bounds=[kotlin.Any])]?/PointingToDeclaration//-1946532649">
<script type="text/javascript" src="../../scripts/main.js"></script> <div class="main-content" id="content" pageIds="KSpigot::net.axay.kspigot.config//kSpigotJsonConfig/#java.io.File#kotlin.Boolean#kotlinx.serialization.json.Json#kotlin.Function0[TypeParam(bounds=[kotlin.Any])]?/PointingToDeclaration//769193423">
<div class="navigation-wrapper" id="navigation-wrapper">
<div class="breadcrumbs"><a href="../../index.html">KSpigot</a>/<a href="index.html">net.axay.kspigot.config</a>/<a href="k-spigot-json-config.html">kSpigotJsonConfig</a></div>
<div class="pull-right d-flex">
@@ -26,9 +26,9 @@
<div class="divergent-group" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main"><div class="with-platform-tags"><span class="pull-right"></span></div>
<div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-depenent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace">inline fun &lt;<a href="k-spigot-json-config.html">T</a> : <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html">Any</a>&gt; <a href="k-spigot-json-config.html">kSpigotJsonConfig</a>(file: <a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html">File</a>, saveAfterLoad: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a> = false, noinline default: () -&gt; <a href="k-spigot-json-config.html">T</a>? = null): <a href="-config-delegate/index.html">ConfigDelegate</a>&lt;<a href="k-spigot-json-config.html">T</a>&gt;<span class="top-right-position"><span class="copy-icon"></span><div class="copy-popup-wrapper popup-to-left"><span class="copy-popup-icon"></span><span>Content copied to clipboard</span></div></span></div></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-depenent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace">inline fun &lt;<a href="k-spigot-json-config.html">T</a> : <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html">Any</a>&gt; <a href="k-spigot-json-config.html">kSpigotJsonConfig</a>(file: <a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html">File</a>, saveAfterLoad: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a> = false, json: <span data-unresolved-link="kotlinx.serialization.json/Json///PointingToDeclaration/">Json</span> = Json, noinline default: () -&gt; <a href="k-spigot-json-config.html">T</a>? = null): <a href="-config-delegate/index.html">ConfigDelegate</a>&lt;<a href="k-spigot-json-config.html">T</a>&gt;<span class="top-right-position"><span class="copy-icon"></span><div class="copy-popup-wrapper popup-to-left"><span class="copy-popup-icon"></span><span>Content copied to clipboard</span></div></span></div></div></div>
</div>
<p class="paragraph">Creates a new ConfigDelegate object.</p><p class="paragraph">You can use this as a delegate (with by) or a normal object. (Delegate allows direct access to the config object, but does not provide save() or reload() methods.)</p><h2 class="">Parameters</h2><div data-togglable="Parameters"><div class="platform-hinted WithExtraAttributes" data-platform-hinted="data-platform-hinted" data-togglable="Parameters"><div class="content sourceset-depenent-content" data-active="" data-togglable=":dokkaHtml/main"><div data-togglable="Parameters"><div class="table" data-togglable="Parameters"><div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main"><div class="main-subrow keyValue WithExtraAttributes"><div class=""><span class="inline-flex">T</span></div><div><div class="title"><div data-togglable="Parameters"><p class="paragraph">The class type of the config.</p></div></div></div></div></div><div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main"><div class="main-subrow keyValue WithExtraAttributes"><div class=""><span class="inline-flex">file</span></div><div><div class="title"><div data-togglable="Parameters"><p class="paragraph">The path to the config.</p></div></div></div></div></div><div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main"><div class="main-subrow keyValue WithExtraAttributes"><div class=""><span class="inline-flex">saveAfterLoad</span></div><div><div class="title"><div data-togglable="Parameters"><p class="paragraph">If true, the loaded config will be saved immediately. This is useful, if the config structure was changed and new default parameters were applied.</p></div></div></div></div></div><div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main"><div class="main-subrow keyValue WithExtraAttributes"><div class=""><span class="inline-flex">default</span></div><div><div class="title"><div data-togglable="Parameters"><p class="paragraph">Optional default config, which will be used if there is no config file and a new one should be created.</p></div></div></div></div></div></div></div></div></div></div><h4 class="">Throws</h4><div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-depenent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="table"><div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><a href="https://docs.oracle.com/javase/8/docs/api/java/io/FileNotFoundException.html">java.io.FileNotFoundException</a></span></div><div><div class="title"><p class="paragraph">If the file does not exist and no default config is specified.</p></div></div></div></div></div></div></div></div>
<p class="paragraph">Creates a new ConfigDelegate object.</p><p class="paragraph">You can use this as a delegate (with by) or a normal object. (Delegate allows direct access to the config object, but does not provide save() or reload() methods.)</p><h2 class="">Parameters</h2><div data-togglable="Parameters"><div class="platform-hinted WithExtraAttributes" data-platform-hinted="data-platform-hinted" data-togglable="Parameters"><div class="content sourceset-depenent-content" data-active="" data-togglable=":dokkaHtml/main"><div data-togglable="Parameters"><div class="table" data-togglable="Parameters"><div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main"><div class="main-subrow keyValue WithExtraAttributes"><div class=""><span class="inline-flex">T</span></div><div><div class="title"><div data-togglable="Parameters"><p class="paragraph">The class type of the config.</p></div></div></div></div></div><div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main"><div class="main-subrow keyValue WithExtraAttributes"><div class=""><span class="inline-flex">file</span></div><div><div class="title"><div data-togglable="Parameters"><p class="paragraph">The path to the config.</p></div></div></div></div></div><div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main"><div class="main-subrow keyValue WithExtraAttributes"><div class=""><span class="inline-flex">saveAfterLoad</span></div><div><div class="title"><div data-togglable="Parameters"><p class="paragraph">If true, the loaded config will be saved immediately. This is useful, if the config structure was changed and new default parameters were applied.</p></div></div></div></div></div><div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main"><div class="main-subrow keyValue WithExtraAttributes"><div class=""><span class="inline-flex">default</span></div><div><div class="title"><div data-togglable="Parameters"><p class="paragraph">Optional default config, which will be used if there is no config file and a new one should be created.</p></div></div></div></div></div><div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main"><div class="main-subrow keyValue WithExtraAttributes"><div class=""><span class="inline-flex">json</span></div><div><div class="title"><div data-togglable="Parameters"><p class="paragraph">The json instance to use for serialization.</p></div></div></div></div></div></div></div></div></div></div><h4 class="">Throws</h4><div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-depenent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="table"><div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><a href="https://docs.oracle.com/javase/8/docs/api/java/io/FileNotFoundException.html">java.io.FileNotFoundException</a></span></div><div><div class="title"><p class="paragraph">If the file does not exist and no default config is specified.</p></div></div></div></div></div></div></div></div>
</div>
<div class="footer"><span class="go-to-top-icon"><a href="#content"></a></span><span>© 2021 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></div>
</div>