Update dokka docs

SilkMC · Sep 1, 2021 · 72d8af3 · 72d8af3
1 parent 544ab87
commit 72d8af3
Show file tree

Hide file tree

Showing 28 changed files with 912 additions and 35 deletions.
diff --git a/docs/fabrikmc-commands/index.html b/docs/fabrikmc-commands/index.html
@@ -23,7 +23,7 @@
           </div>
           <div class="cover ">
             <h1 class="cover"><span>fabrikmc-commands</span></h1>
-            <div class="platform-hinted UnderCoverText" data-platform-hinted="data-platform-hinted"><div class="content sourceset-depenent-content" data-active="" data-togglable=":fabrikmc-commands:dokkaHtmlPartial/main"><p class="paragraph">A command DSL, built on top of Brigardier - the idea of this DSL is to bring the Kotlin builder style to Brigardier. This DSL does not wrap Brigardier, it just extends it.</p><h3 class=""> Dependency</h3><div class="sample-container"><code class="" theme="idea"><pre>modImplementation("net.axay:fabrikmc-commands:1.2.2")</pre></code></div><h2 class=""> Creating a command</h2><p class="paragraph">You can open a new command builder using the <code>command</code> function:</p><div class="sample-container"><code class="" theme="idea"><pre>command("mycommand") {<br>    // the command builder<br>}</pre></code></div><p class="paragraph">For a command which should be handled by the client, use the <code>clientCommand</code> function instead.</p><h2 class=""> Registering the command</h2><p class="paragraph">This command will be registered automatically if it is initialized at the correct moment (during initialization of your mod).</p><p class="paragraph">If you need to register it manually, call the <code>setupRegistrationCallback()</code> (server-side) or <code>register()</code> (client-side) functions by yourself.</p></div></div>
+            <div class="platform-hinted UnderCoverText" data-platform-hinted="data-platform-hinted"><div class="content sourceset-depenent-content" data-active="" data-togglable=":fabrikmc-commands:dokkaHtmlPartial/main"><p class="paragraph">A command DSL, built on top of Brigardier - the idea of this DSL is to bring the Kotlin builder style to Brigardier. This DSL does not wrap Brigardier, it just extends it.</p><h3 class=""> Dependency</h3><div class="sample-container"><code class="" theme="idea"><pre>modImplementation("net.axay:fabrikmc-commands:1.3.0")</pre></code></div><h2 class=""> Creating a command</h2><p class="paragraph">You can open a new command builder using the <code>command</code> function:</p><div class="sample-container"><code class="" theme="idea"><pre>command("mycommand") {<br>    // the command builder<br>}</pre></code></div><p class="paragraph">For a command which should be handled by the client, use the <code>clientCommand</code> function instead.</p><h2 class=""> Registering the command</h2><p class="paragraph">This command will be registered automatically if it is initialized at the correct moment (during initialization of your mod).</p><p class="paragraph">If you need to register it manually, call the <code>setupRegistrationCallback()</code> (server-side) or <code>register()</code> (client-side) functions by yourself.</p></div></div>
           </div>
           <h2 class="">Packages</h2>
           <div class="table"><a data-name="686923325%2FPackages%2F1397106568" anchor-label="net.axay.fabrik.commands" id="686923325%2FPackages%2F1397106568" data-filterable-set=":fabrikmc-commands:dokkaHtmlPartial/main"></a>

diff --git a/docs/fabrikmc-commands/navigation.html b/docs/fabrikmc-commands/navigation.html
@@ -32,16 +32,61 @@
      <a href="../fabrikmc-commands/net.axay.fabrik.commands/literal.html"><span>literal</span></a>
     </div> 
    </div> 
-   <div class="sideMenuPart" id="fabrikmc-commands-nav-submenu-0-5" pageid="fabrikmc-commands::net.axay.fabrik.commands//simpleExecutes/com.mojang.brigadier.builder.ArgumentBuilder[TypeParam(bounds=[kotlin.Any?]),*]#kotlin.Function1[net.axay.fabrik.commands.internal.SimpleCommandContext[TypeParam(bounds=[kotlin.Any?])],kotlin.Unit]/PointingToDeclaration//1397106568"> 
+   <div class="sideMenuPart" id="fabrikmc-commands-nav-submenu-0-5" pageid="fabrikmc-commands::net.axay.fabrik.commands//runs/com.mojang.brigadier.builder.ArgumentBuilder[TypeParam(bounds=[kotlin.Any?]),*]#kotlin.Function1[net.axay.fabrik.commands.internal.SimpleCommandContext[TypeParam(bounds=[kotlin.Any?])],kotlin.Unit]/PointingToDeclaration//1397106568"> 
+    <div class="overview">
+     <a href="../fabrikmc-commands/net.axay.fabrik.commands/runs.html"><span>runs</span></a>
+    </div> 
+   </div> 
+   <div class="sideMenuPart" id="fabrikmc-commands-nav-submenu-0-6" pageid="fabrikmc-commands::net.axay.fabrik.commands//simpleExecutes/com.mojang.brigadier.builder.ArgumentBuilder[TypeParam(bounds=[kotlin.Any?]),*]#kotlin.Function1[net.axay.fabrik.commands.internal.SimpleCommandContext[TypeParam(bounds=[kotlin.Any?])],kotlin.Unit]/PointingToDeclaration//1397106568"> 
     <div class="overview">
      <a href="../fabrikmc-commands/net.axay.fabrik.commands/simple-executes.html"><span>simple</span><wbr><span>Executes()</span></a>
     </div> 
    </div> 
-   <div class="sideMenuPart" id="fabrikmc-commands-nav-submenu-0-6" pageid="fabrikmc-commands::net.axay.fabrik.commands//simpleSuggests/com.mojang.brigadier.builder.RequiredArgumentBuilder[TypeParam(bounds=[kotlin.Any?]),*]#kotlinx.coroutines.CoroutineScope#kotlin.coroutines.SuspendFunction1[com.mojang.brigadier.context.CommandContext[TypeParam(bounds=[kotlin.Any?])],kotlin.collections.Iterable[kotlin.Any?]?]/PointingToDeclaration//1397106568"> 
+   <div class="sideMenuPart" id="fabrikmc-commands-nav-submenu-0-7" pageid="fabrikmc-commands::net.axay.fabrik.commands//simpleSuggests/com.mojang.brigadier.builder.RequiredArgumentBuilder[TypeParam(bounds=[kotlin.Any?]),*]#kotlinx.coroutines.CoroutineScope#kotlin.coroutines.SuspendFunction1[com.mojang.brigadier.context.CommandContext[TypeParam(bounds=[kotlin.Any?])],kotlin.collections.Iterable[kotlin.Any?]?]/PointingToDeclaration//1397106568"> 
     <div class="overview">
      <a href="../fabrikmc-commands/net.axay.fabrik.commands/simple-suggests.html"><span>simple</span><wbr><span>Suggests()</span></a>
     </div> 
    </div> 
+   <div class="sideMenuPart" id="fabrikmc-commands-nav-submenu-0-8" pageid="fabrikmc-commands::net.axay.fabrik.commands//suggestList/com.mojang.brigadier.builder.RequiredArgumentBuilder[TypeParam(bounds=[kotlin.Any?]),*]#kotlin.Function1[com.mojang.brigadier.context.CommandContext[TypeParam(bounds=[kotlin.Any?])],kotlin.collections.Iterable[kotlin.Any?]?]/PointingToDeclaration//1397106568"> 
+    <div class="overview">
+     <a href="../fabrikmc-commands/net.axay.fabrik.commands/suggest-list.html"><span>suggest</span><wbr><span>List()</span></a>
+    </div> 
+   </div> 
+   <div class="sideMenuPart" id="fabrikmc-commands-nav-submenu-0-9" pageid="fabrikmc-commands::net.axay.fabrik.commands//suggestListSuspending/com.mojang.brigadier.builder.RequiredArgumentBuilder[TypeParam(bounds=[kotlin.Any?]),*]#kotlinx.coroutines.CoroutineScope#kotlin.coroutines.SuspendFunction1[com.mojang.brigadier.context.CommandContext[TypeParam(bounds=[kotlin.Any?])],kotlin.collections.Iterable[kotlin.Any?]?]/PointingToDeclaration//1397106568"> 
+    <div class="overview">
+     <a href="../fabrikmc-commands/net.axay.fabrik.commands/suggest-list-suspending.html"><span>suggest</span><wbr><span>List</span><wbr><span>Suspending()</span></a>
+    </div> 
+   </div> 
+   <div class="sideMenuPart" id="fabrikmc-commands-nav-submenu-0-10" pageid="fabrikmc-commands::net.axay.fabrik.commands//suggestListWithTooltips/com.mojang.brigadier.builder.RequiredArgumentBuilder[TypeParam(bounds=[kotlin.Any?]),*]#kotlin.Function1[com.mojang.brigadier.context.CommandContext[TypeParam(bounds=[kotlin.Any?])],kotlin.collections.Iterable[kotlin.Pair[kotlin.Any?,com.mojang.brigadier.Message]?]?]/PointingToDeclaration//1397106568"> 
+    <div class="overview">
+     <a href="../fabrikmc-commands/net.axay.fabrik.commands/suggest-list-with-tooltips.html"><span>suggest</span><wbr><span>List</span><wbr><span>With</span><wbr><span>Tooltips()</span></a>
+    </div> 
+   </div> 
+   <div class="sideMenuPart" id="fabrikmc-commands-nav-submenu-0-11" pageid="fabrikmc-commands::net.axay.fabrik.commands//suggestListWithTooltipsSuspending/com.mojang.brigadier.builder.RequiredArgumentBuilder[TypeParam(bounds=[kotlin.Any?]),*]#kotlinx.coroutines.CoroutineScope#kotlin.Function1[com.mojang.brigadier.context.CommandContext[TypeParam(bounds=[kotlin.Any?])],kotlin.collections.Iterable[kotlin.Pair[kotlin.Any?,com.mojang.brigadier.Message]?]?]/PointingToDeclaration//1397106568"> 
+    <div class="overview">
+     <a href="../fabrikmc-commands/net.axay.fabrik.commands/suggest-list-with-tooltips-suspending.html"><span>suggest</span><wbr><span>List</span><wbr><span>With</span><wbr><span>Tooltips</span><wbr><span>Suspending()</span></a>
+    </div> 
+   </div> 
+   <div class="sideMenuPart" id="fabrikmc-commands-nav-submenu-0-12" pageid="fabrikmc-commands::net.axay.fabrik.commands//suggestSingle/com.mojang.brigadier.builder.RequiredArgumentBuilder[TypeParam(bounds=[kotlin.Any?]),*]#kotlin.Function1[com.mojang.brigadier.context.CommandContext[TypeParam(bounds=[kotlin.Any?])],kotlin.Any?]/PointingToDeclaration//1397106568"> 
+    <div class="overview">
+     <a href="../fabrikmc-commands/net.axay.fabrik.commands/suggest-single.html"><span>suggest</span><wbr><span>Single()</span></a>
+    </div> 
+   </div> 
+   <div class="sideMenuPart" id="fabrikmc-commands-nav-submenu-0-13" pageid="fabrikmc-commands::net.axay.fabrik.commands//suggestSingleSuspending/com.mojang.brigadier.builder.RequiredArgumentBuilder[TypeParam(bounds=[kotlin.Any?]),*]#kotlinx.coroutines.CoroutineScope#kotlin.coroutines.SuspendFunction1[com.mojang.brigadier.context.CommandContext[TypeParam(bounds=[kotlin.Any?])],kotlin.Any?]/PointingToDeclaration//1397106568"> 
+    <div class="overview">
+     <a href="../fabrikmc-commands/net.axay.fabrik.commands/suggest-single-suspending.html"><span>suggest</span><wbr><span>Single</span><wbr><span>Suspending()</span></a>
+    </div> 
+   </div> 
+   <div class="sideMenuPart" id="fabrikmc-commands-nav-submenu-0-14" pageid="fabrikmc-commands::net.axay.fabrik.commands//suggestSingleWithTooltip/com.mojang.brigadier.builder.RequiredArgumentBuilder[TypeParam(bounds=[kotlin.Any?]),*]#kotlin.Function1[com.mojang.brigadier.context.CommandContext[TypeParam(bounds=[kotlin.Any?])],kotlin.Pair[kotlin.Any,com.mojang.brigadier.Message]?]/PointingToDeclaration//1397106568"> 
+    <div class="overview">
+     <a href="../fabrikmc-commands/net.axay.fabrik.commands/suggest-single-with-tooltip.html"><span>suggest</span><wbr><span>Single</span><wbr><span>With</span><wbr><span>Tooltip()</span></a>
+    </div> 
+   </div> 
+   <div class="sideMenuPart" id="fabrikmc-commands-nav-submenu-0-15" pageid="fabrikmc-commands::net.axay.fabrik.commands//suggestSingleWithTooltipSuspending/com.mojang.brigadier.builder.RequiredArgumentBuilder[TypeParam(bounds=[kotlin.Any?]),*]#kotlinx.coroutines.CoroutineScope#kotlin.coroutines.SuspendFunction1[com.mojang.brigadier.context.CommandContext[TypeParam(bounds=[kotlin.Any?])],kotlin.Pair[kotlin.Any?,com.mojang.brigadier.Message]?]/PointingToDeclaration//1397106568"> 
+    <div class="overview">
+     <a href="../fabrikmc-commands/net.axay.fabrik.commands/suggest-single-with-tooltip-suspending.html"><span>suggest</span><wbr><span>Single</span><wbr><span>With</span><wbr><span>Tooltip</span><wbr><span>Suspending()</span></a>
+    </div> 
+   </div> 
   </div> 
   <div class="sideMenuPart" id="fabrikmc-commands-nav-submenu-1" pageid="fabrikmc-commands::net.axay.fabrik.commands.registration////PointingToDeclaration//1397106568"> 
    <div class="overview">

diff --git a/docs/fabrikmc-commands/net.axay.fabrik.commands/client-command.html b/docs/fabrikmc-commands/net.axay.fabrik.commands/client-command.html
@@ -31,10 +31,10 @@ <h1 class="cover"><span>client</span><wbr><span>Command</span></h1>
   </div>
 <p class="paragraph">Creates a new client command. This command will work on the client, even if the player is connected to a third party server.</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=":fabrikmc-commands:dokkaHtmlPartial/main"><div data-togglable="Parameters"><div class="table" data-togglable="Parameters"><div class="table-row" data-filterable-current=":fabrikmc-commands:dokkaHtmlPartial/main" data-filterable-set=":fabrikmc-commands:dokkaHtmlPartial/main"><div class="main-subrow keyValue WithExtraAttributes"><div class=""><span class="inline-flex">name</span></div><div><div class="title"><div data-togglable="Parameters"><p class="paragraph">the name of the root command</p></div></div></div></div></div><div class="table-row" data-filterable-current=":fabrikmc-commands:dokkaHtmlPartial/main" data-filterable-set=":fabrikmc-commands:dokkaHtmlPartial/main"><div class="main-subrow keyValue WithExtraAttributes"><div class=""><span class="inline-flex">register</span></div><div><div class="title"><div data-togglable="Parameters"><p class="paragraph">if true, the command will automatically be registered</p></div></div></div></div></div></div></div></div></div></div></div>
           <h2 class="">Sources</h2>
-          <div class="table" data-togglable="Sources"><a data-name="2009995342%2FSource%2F1397106568" anchor-label="https://github.com/jakobkmar/fabrikmc/tree/main/fabrikmc-commands/src/main/kotlin/net/axay/fabrik/commands/BrigardierWrapper.kt#L39" id="2009995342%2FSource%2F1397106568" data-filterable-set=":fabrikmc-commands:dokkaHtmlPartial/main"></a>
+          <div class="table" data-togglable="Sources"><a data-name="2009995342%2FSource%2F1397106568" anchor-label="https://github.com/jakobkmar/fabrikmc/tree/main/fabrikmc-commands/src/main/kotlin/net/axay/fabrik/commands/Creation.kt#L30" id="2009995342%2FSource%2F1397106568" data-filterable-set=":fabrikmc-commands:dokkaHtmlPartial/main"></a>
             <div class="table-row" data-filterable-current=":fabrikmc-commands:dokkaHtmlPartial/main" data-filterable-set=":fabrikmc-commands:dokkaHtmlPartial/main">
               <div class="main-subrow keyValue ">
-                <div class=""><span class="inline-flex"><a href="https://github.com/jakobkmar/fabrikmc/tree/main/fabrikmc-commands/src/main/kotlin/net/axay/fabrik/commands/BrigardierWrapper.kt#L39">jvm source</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="2009995342%2FSource%2F1397106568"></span>
+                <div class=""><span class="inline-flex"><a href="https://github.com/jakobkmar/fabrikmc/tree/main/fabrikmc-commands/src/main/kotlin/net/axay/fabrik/commands/Creation.kt#L30">jvm source</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="2009995342%2FSource%2F1397106568"></span>
                       <div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
                     </span></span></div>
                 <div></div>

diff --git a/docs/fabrikmc-commands/net.axay.fabrik.commands/command.html b/docs/fabrikmc-commands/net.axay.fabrik.commands/command.html
@@ -31,10 +31,10 @@ <h1 class="cover"><span>command</span></h1>
   </div>
 <p class="paragraph">Creates a new command.</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=":fabrikmc-commands:dokkaHtmlPartial/main"><div data-togglable="Parameters"><div class="table" data-togglable="Parameters"><div class="table-row" data-filterable-current=":fabrikmc-commands:dokkaHtmlPartial/main" data-filterable-set=":fabrikmc-commands:dokkaHtmlPartial/main"><div class="main-subrow keyValue WithExtraAttributes"><div class=""><span class="inline-flex">name</span></div><div><div class="title"><div data-togglable="Parameters"><p class="paragraph">the name of the root command</p></div></div></div></div></div><div class="table-row" data-filterable-current=":fabrikmc-commands:dokkaHtmlPartial/main" data-filterable-set=":fabrikmc-commands:dokkaHtmlPartial/main"><div class="main-subrow keyValue WithExtraAttributes"><div class=""><span class="inline-flex">register</span></div><div><div class="title"><div data-togglable="Parameters"><p class="paragraph">if true, the command will automatically be registered</p></div></div></div></div></div></div></div></div></div></div></div>
           <h2 class="">Sources</h2>
-          <div class="table" data-togglable="Sources"><a data-name="-1591607554%2FSource%2F1397106568" anchor-label="https://github.com/jakobkmar/fabrikmc/tree/main/fabrikmc-commands/src/main/kotlin/net/axay/fabrik/commands/BrigardierWrapper.kt#L23" id="-1591607554%2FSource%2F1397106568" data-filterable-set=":fabrikmc-commands:dokkaHtmlPartial/main"></a>
+          <div class="table" data-togglable="Sources"><a data-name="-1591607554%2FSource%2F1397106568" anchor-label="https://github.com/jakobkmar/fabrikmc/tree/main/fabrikmc-commands/src/main/kotlin/net/axay/fabrik/commands/Creation.kt#L14" id="-1591607554%2FSource%2F1397106568" data-filterable-set=":fabrikmc-commands:dokkaHtmlPartial/main"></a>
             <div class="table-row" data-filterable-current=":fabrikmc-commands:dokkaHtmlPartial/main" data-filterable-set=":fabrikmc-commands:dokkaHtmlPartial/main">
               <div class="main-subrow keyValue ">
-                <div class=""><span class="inline-flex"><a href="https://github.com/jakobkmar/fabrikmc/tree/main/fabrikmc-commands/src/main/kotlin/net/axay/fabrik/commands/BrigardierWrapper.kt#L23">jvm source</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1591607554%2FSource%2F1397106568"></span>
+                <div class=""><span class="inline-flex"><a href="https://github.com/jakobkmar/fabrikmc/tree/main/fabrikmc-commands/src/main/kotlin/net/axay/fabrik/commands/Creation.kt#L14">jvm source</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1591607554%2FSource%2F1397106568"></span>
                       <div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
                     </span></span></div>
                 <div></div>