Update dokka docs

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

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.gui/GUIShared///PointingToDeclaration//-1946532649">
<script type="text/javascript" src="../../../scripts/main.js"></script> <div class="main-content" id="content" pageIds="KSpigot::net.axay.kspigot.gui/GUIShared///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.gui</a>/<a href="index.html">GUIShared</a></div>
<div class="pull-right d-flex">
@@ -28,10 +28,10 @@
<div class="tabs-section" tabs-section="tabs-section"><button class="section-tab" data-active="" data-togglable="Functions">Functions</button><button class="section-tab" data-togglable="Properties">Properties</button></div>
<div class="tabs-section-body">
<h2 class="">Functions</h2>
<div class="table" data-togglable="Functions"><a data-name="%5Bnet.axay.kspigot.gui%2FGUIShared%2FcloseGUI%2F%23%2FPointingToDeclaration%2F%5D%2FFunctions%2F-1946532649" anchor-label="closeGUI" id="%5Bnet.axay.kspigot.gui%2FGUIShared%2FcloseGUI%2F%23%2FPointingToDeclaration%2F%5D%2FFunctions%2F-1946532649" data-filterable-set=":dokkaHtml/main"></a>
<div class="table" data-togglable="Functions"><a data-name="-100576954%2FFunctions%2F769193423" anchor-label="closeGUI" id="-100576954%2FFunctions%2F769193423" data-filterable-set=":dokkaHtml/main"></a>
<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="close-g-u-i.html">closeGUI</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="%5Bnet.axay.kspigot.gui%2FGUIShared%2FcloseGUI%2F%23%2FPointingToDeclaration%2F%5D%2FFunctions%2F-1946532649"></span>
<div class=""><span class="inline-flex"><a href="close-g-u-i.html">closeGUI</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-100576954%2FFunctions%2F769193423"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
@@ -40,15 +40,15 @@
<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">open override fun <a href="close-g-u-i.html">closeGUI</a>()<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>
<a data-name="%5Bnet.axay.kspigot.gui%2FGUIShared%2FcloseGUI%2F%23%2FPointingToDeclaration%2F%5D%2FFunctions%2F-1946532649" anchor-label="closeGUI" id="%5Bnet.axay.kspigot.gui%2FGUIShared%2FcloseGUI%2F%23%2FPointingToDeclaration%2F%5D%2FFunctions%2F-1946532649" data-filterable-set=":dokkaHtml/main"></a><div class="brief "><a data-name="%5Bnet.axay.kspigot.gui%2FGUIShared%2FcloseGUI%2F%23%2FPointingToDeclaration%2F%5D%2FFunctions%2F-1946532649" anchor-label="closeGUI" id="%5Bnet.axay.kspigot.gui%2FGUIShared%2FcloseGUI%2F%23%2FPointingToDeclaration%2F%5D%2FFunctions%2F-1946532649" data-filterable-set=":dokkaHtml/main"></a>Closes this GUI for all viewers and unregisters all instances.</div></div>
<a data-name="-100576954%2FFunctions%2F769193423" anchor-label="closeGUI" id="-100576954%2FFunctions%2F769193423" data-filterable-set=":dokkaHtml/main"></a><div class="brief "><a data-name="-100576954%2FFunctions%2F769193423" anchor-label="closeGUI" id="-100576954%2FFunctions%2F769193423" data-filterable-set=":dokkaHtml/main"></a>Closes this GUI for all viewers and unregisters all instances.</div></div>
</div>
</div>
</div>
</div>
<a data-name="%5Bnet.axay.kspigot.gui%2FGUIShared%2FgetAllInstances%2F%23%2FPointingToDeclaration%2F%5D%2FFunctions%2F-1946532649" anchor-label="getAllInstances" id="%5Bnet.axay.kspigot.gui%2FGUIShared%2FgetAllInstances%2F%23%2FPointingToDeclaration%2F%5D%2FFunctions%2F-1946532649" data-filterable-set=":dokkaHtml/main"></a>
<a data-name="1120061694%2FFunctions%2F769193423" anchor-label="getAllInstances" id="1120061694%2FFunctions%2F769193423" data-filterable-set=":dokkaHtml/main"></a>
<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="get-all-instances.html">getAllInstances</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="%5Bnet.axay.kspigot.gui%2FGUIShared%2FgetAllInstances%2F%23%2FPointingToDeclaration%2F%5D%2FFunctions%2F-1946532649"></span>
<div class=""><span class="inline-flex"><a href="get-all-instances.html">getAllInstances</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1120061694%2FFunctions%2F769193423"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
@@ -57,15 +57,15 @@
<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">open override fun <a href="get-all-instances.html">getAllInstances</a>(): <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html">List</a>&lt;<a href="../-g-u-i-instance/index.html">GUIInstance</a>&lt;<a href="index.html">T</a>&gt;&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>
<a data-name="%5Bnet.axay.kspigot.gui%2FGUIShared%2FgetAllInstances%2F%23%2FPointingToDeclaration%2F%5D%2FFunctions%2F-1946532649" anchor-label="getAllInstances" id="%5Bnet.axay.kspigot.gui%2FGUIShared%2FgetAllInstances%2F%23%2FPointingToDeclaration%2F%5D%2FFunctions%2F-1946532649" data-filterable-set=":dokkaHtml/main"></a><div class="brief "><a data-name="%5Bnet.axay.kspigot.gui%2FGUIShared%2FgetAllInstances%2F%23%2FPointingToDeclaration%2F%5D%2FFunctions%2F-1946532649" anchor-label="getAllInstances" id="%5Bnet.axay.kspigot.gui%2FGUIShared%2FgetAllInstances%2F%23%2FPointingToDeclaration%2F%5D%2FFunctions%2F-1946532649" data-filterable-set=":dokkaHtml/main"></a>Returns all active instances of this GUI.</div></div>
<a data-name="1120061694%2FFunctions%2F769193423" anchor-label="getAllInstances" id="1120061694%2FFunctions%2F769193423" data-filterable-set=":dokkaHtml/main"></a><div class="brief "><a data-name="1120061694%2FFunctions%2F769193423" anchor-label="getAllInstances" id="1120061694%2FFunctions%2F769193423" data-filterable-set=":dokkaHtml/main"></a>Returns all active instances of this GUI.</div></div>
</div>
</div>
</div>
</div>
<a data-name="%5Bnet.axay.kspigot.gui%2FGUIShared%2FgetInstance%2F%23org.bukkit.entity.Player%2FPointingToDeclaration%2F%5D%2FFunctions%2F-1946532649" anchor-label="getInstance" id="%5Bnet.axay.kspigot.gui%2FGUIShared%2FgetInstance%2F%23org.bukkit.entity.Player%2FPointingToDeclaration%2F%5D%2FFunctions%2F-1946532649" data-filterable-set=":dokkaHtml/main"></a>
<a data-name="-627851552%2FFunctions%2F769193423" anchor-label="getInstance" id="-627851552%2FFunctions%2F769193423" data-filterable-set=":dokkaHtml/main"></a>
<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="get-instance.html">getInstance</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="%5Bnet.axay.kspigot.gui%2FGUIShared%2FgetInstance%2F%23org.bukkit.entity.Player%2FPointingToDeclaration%2F%5D%2FFunctions%2F-1946532649"></span>
<div class=""><span class="inline-flex"><a href="get-instance.html">getInstance</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-627851552%2FFunctions%2F769193423"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
@@ -74,35 +74,35 @@
<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">open override fun <a href="get-instance.html">getInstance</a>(player: <span data-unresolved-link="org.bukkit.entity/Player///PointingToDeclaration/">Player</span>): <a href="../-g-u-i-instance/index.html">GUIInstance</a>&lt;<a href="index.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>
<a data-name="%5Bnet.axay.kspigot.gui%2FGUIShared%2FgetInstance%2F%23org.bukkit.entity.Player%2FPointingToDeclaration%2F%5D%2FFunctions%2F-1946532649" anchor-label="getInstance" id="%5Bnet.axay.kspigot.gui%2FGUIShared%2FgetInstance%2F%23org.bukkit.entity.Player%2FPointingToDeclaration%2F%5D%2FFunctions%2F-1946532649" data-filterable-set=":dokkaHtml/main"></a><div class="brief "><a data-name="%5Bnet.axay.kspigot.gui%2FGUIShared%2FgetInstance%2F%23org.bukkit.entity.Player%2FPointingToDeclaration%2F%5D%2FFunctions%2F-1946532649" anchor-label="getInstance" id="%5Bnet.axay.kspigot.gui%2FGUIShared%2FgetInstance%2F%23org.bukkit.entity.Player%2FPointingToDeclaration%2F%5D%2FFunctions%2F-1946532649" data-filterable-set=":dokkaHtml/main"></a>Returns the instance beloning to the given player.</div></div>
<a data-name="-627851552%2FFunctions%2F769193423" anchor-label="getInstance" id="-627851552%2FFunctions%2F769193423" data-filterable-set=":dokkaHtml/main"></a><div class="brief "><a data-name="-627851552%2FFunctions%2F769193423" anchor-label="getInstance" id="-627851552%2FFunctions%2F769193423" data-filterable-set=":dokkaHtml/main"></a>Returns the instance beloning to the given player.</div></div>
</div>
</div>
</div>
</div>
</div>
<h2 class="">Properties</h2>
<div class="table" data-togglable="Properties"><a data-name="%5Bnet.axay.kspigot.gui%2FGUIShared%2Fdata%2F%23%2FPointingToDeclaration%2F%5D%2FProperties%2F-1946532649" anchor-label="data" id="%5Bnet.axay.kspigot.gui%2FGUIShared%2Fdata%2F%23%2FPointingToDeclaration%2F%5D%2FProperties%2F-1946532649" data-filterable-set=":dokkaHtml/main"></a>
<div class="table" data-togglable="Properties"><a data-name="-1467321953%2FProperties%2F769193423" anchor-label="data" id="-1467321953%2FProperties%2F769193423" data-filterable-set=":dokkaHtml/main"></a>
<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="index.html#%5Bnet.axay.kspigot.gui%2FGUIShared%2Fdata%2F%23%2FPointingToDeclaration%2F%5D%2FProperties%2F-1946532649">data</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="%5Bnet.axay.kspigot.gui%2FGUIShared%2Fdata%2F%23%2FPointingToDeclaration%2F%5D%2FProperties%2F-1946532649"></span>
<div class=""><span class="inline-flex"><a href="index.html#-1467321953%2FProperties%2F769193423">data</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1467321953%2FProperties%2F769193423"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted" data-togglable="Properties"><div class="content sourceset-depenent-content" data-active="" data-togglable=":dokkaHtml/main"><a data-name="%5Bnet.axay.kspigot.gui%2FGUIShared%2Fdata%2F%23%2FPointingToDeclaration%2F%5D%2FProperties%2F-1946532649" anchor-label="data" id="%5Bnet.axay.kspigot.gui%2FGUIShared%2Fdata%2F%23%2FPointingToDeclaration%2F%5D%2FProperties%2F-1946532649" data-filterable-set=":dokkaHtml/main"></a><div class="symbol monospace">val <a href="index.html#%5Bnet.axay.kspigot.gui%2FGUIShared%2Fdata%2F%23%2FPointingToDeclaration%2F%5D%2FProperties%2F-1946532649">data</a>: <a href="../-g-u-i-data/index.html">GUIData</a>&lt;<a href="index.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" data-togglable="Properties"><div class="content sourceset-depenent-content" data-active="" data-togglable=":dokkaHtml/main"><a data-name="-1467321953%2FProperties%2F769193423" anchor-label="data" id="-1467321953%2FProperties%2F769193423" data-filterable-set=":dokkaHtml/main"></a><div class="symbol monospace">val <a href="index.html#-1467321953%2FProperties%2F769193423">data</a>: <a href="../-g-u-i-data/index.html">GUIData</a>&lt;<a href="index.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>
</div>
</div>
</div>
<a data-name="%5Bnet.axay.kspigot.gui%2FGUIShared%2FsingleInstance%2F%23%2FPointingToDeclaration%2F%5D%2FProperties%2F-1946532649" anchor-label="singleInstance" id="%5Bnet.axay.kspigot.gui%2FGUIShared%2FsingleInstance%2F%23%2FPointingToDeclaration%2F%5D%2FProperties%2F-1946532649" data-filterable-set=":dokkaHtml/main"></a>
<a data-name="-1116024660%2FProperties%2F769193423" anchor-label="singleInstance" id="-1116024660%2FProperties%2F769193423" data-filterable-set=":dokkaHtml/main"></a>
<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="single-instance.html">singleInstance</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="%5Bnet.axay.kspigot.gui%2FGUIShared%2FsingleInstance%2F%23%2FPointingToDeclaration%2F%5D%2FProperties%2F-1946532649"></span>
<div class=""><span class="inline-flex"><a href="single-instance.html">singleInstance</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1116024660%2FProperties%2F769193423"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted" data-togglable="Properties"><div class="content sourceset-depenent-content" data-active="" data-togglable=":dokkaHtml/main"><a data-name="%5Bnet.axay.kspigot.gui%2FGUIShared%2FsingleInstance%2F%23%2FPointingToDeclaration%2F%5D%2FProperties%2F-1946532649" anchor-label="singleInstance" id="%5Bnet.axay.kspigot.gui%2FGUIShared%2FsingleInstance%2F%23%2FPointingToDeclaration%2F%5D%2FProperties%2F-1946532649" data-filterable-set=":dokkaHtml/main"></a><div class="symbol monospace">val <a href="single-instance.html">singleInstance</a>: <a href="../-g-u-i-instance/index.html">GUIInstance</a>&lt;<a href="index.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" data-togglable="Properties"><div class="content sourceset-depenent-content" data-active="" data-togglable=":dokkaHtml/main"><a data-name="-1116024660%2FProperties%2F769193423" anchor-label="singleInstance" id="-1116024660%2FProperties%2F769193423" data-filterable-set=":dokkaHtml/main"></a><div class="symbol monospace">val <a href="single-instance.html">singleInstance</a>: <a href="../-g-u-i-instance/index.html">GUIInstance</a>&lt;<a href="index.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>
</div>
</div>