Skip to content

Commit

Permalink
Update Dokka docs for 1.8.1 release
Browse files Browse the repository at this point in the history
  • Loading branch information
jakobkmar committed Jun 10, 2022
1 parent 3f59990 commit 8485484
Show file tree
Hide file tree
Showing 177 changed files with 686 additions and 338 deletions.
2 changes: 1 addition & 1 deletion docs/fabrikmc-commands/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@
<div class="breadcrumbs"></div>
<div class="cover ">
<h1 class="cover"><span><span>fabrikmc-commands</span></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 Brigadier - the idea of this DSL is to bring the Kotlin builder style to Brigadier. This DSL does not hide vanilla Brigadier from you.</p><h3 class=""> Dependency</h3><div class="sample-container"><pre><code class="block lang-kt" theme="idea">modImplementation("net.axay:fabrikmc-commands:1.8.0")</code></pre><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><h2 class=""> Usage</h2><p class="paragraph">You first have to create a command instance using the <a href="net.axay.fabrik.commands/command.html">command</a> or <a href="net.axay.fabrik.commands/client-command.html">clientCommand</a> function. <br> Have a look at the <code class="lang-kotlin">commands</code> package below for more information.</p><p class="paragraph">After that, you can register that command instance. <br> Have a look at the <code class="lang-kotlin">commands.registration</code> package below to see if you have to do it manually, and if yes, how.</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 Brigadier - the idea of this DSL is to bring the Kotlin builder style to Brigadier. This DSL does not hide vanilla Brigadier from you.</p><h3 class=""> Dependency</h3><div class="sample-container"><pre><code class="block lang-kt" theme="idea">modImplementation("net.axay:fabrikmc-commands:1.8.1")</code></pre><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><h2 class=""> Usage</h2><p class="paragraph">You first have to create a command instance using the <a href="net.axay.fabrik.commands/command.html">command</a> or <a href="net.axay.fabrik.commands/client-command.html">clientCommand</a> function. <br> Have a look at the <code class="lang-kotlin">commands</code> package below for more information.</p><p class="paragraph">After that, you can register that command instance. <br> Have a look at the <code class="lang-kotlin">commands.registration</code> package below to see if you have to do it manually, and if yes, how.</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>
Expand Down
10 changes: 10 additions & 0 deletions docs/fabrikmc-commands/navigation.html
Original file line number Diff line number Diff line change
Expand Up @@ -192,6 +192,16 @@
<a href="../fabrikmc-core/net.axay.fabrik.core.item/set-potion.html"><span>set</span><wbr><span><span>Potion()</span></span></a>
</div>
</div>
<div class="sideMenuPart" id="fabrikmc-core-nav-submenu-3-4" pageid="fabrikmc-core::net.axay.fabrik.core.item//setSkullPlayer/net.minecraft.world.item.ItemStack#net.minecraft.server.level.ServerPlayer/PointingToDeclaration//-1552142639">
<div class="overview">
<a href="../fabrikmc-core/net.axay.fabrik.core.item/set-skull-player.html"><span>set</span><wbr><span>Skull</span><wbr><span><span>Player()</span></span></a>
</div>
</div>
<div class="sideMenuPart" id="fabrikmc-core-nav-submenu-3-5" pageid="fabrikmc-core::net.axay.fabrik.core.item//setSkullTexture/net.minecraft.world.item.ItemStack#kotlin.String#java.util.UUID/PointingToDeclaration//-1552142639">
<div class="overview">
<a href="../fabrikmc-core/net.axay.fabrik.core.item/set-skull-texture.html"><span>set</span><wbr><span>Skull</span><wbr><span><span>Texture()</span></span></a>
</div>
</div>
</div>
<div class="sideMenuPart" id="fabrikmc-core-nav-submenu-4" pageid="fabrikmc-core::net.axay.fabrik.core.kotlin////PointingToDeclaration//-1552142639">
<div class="overview">
Expand Down

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
Expand Up @@ -43,24 +43,24 @@
<div class="cover ">
<h1 class="cover"><span><span>register</span></span></h1>
</div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-depenent-content" data-active="" data-togglable=":fabrikmc-commands:dokkaHtmlPartial/main"><div class="symbol monospace"><div class="block"><div class="block"><span class="token annotation">@</span><span data-unresolved-link="net.fabricmc.api/Environment///PointingToDeclaration/"><span class="token annotation">Environment</span></span><span class="token punctuation">(</span><span>value<span class="token operator"> = </span><span data-unresolved-link="net.fabricmc.api/EnvType.CLIENT///PointingToDeclaration/">EnvType.CLIENT</span></span><wbr><span class="token punctuation">)</span></div></div><span class="token keyword"></span><span class="token keyword">fun </span><span data-unresolved-link="com.mojang.brigadier.builder/LiteralArgumentBuilder///PointingToDeclaration/">LiteralArgumentBuilder</span><span class="token operator">&lt;</span><span class="token keyword"></span><a href="https://maven.fabricmc.net/docs/fabric-api-0.53.4+1.19/net/fabricmc/fabric/api/client/command/v2/FabricClientCommandSource.html">FabricClientCommandSource</a><span class="token operator">&gt;</span><span class="token punctuation">.</span><a href="register.html"><span class="token function">register</span></a><span class="token punctuation">(</span><span class="token punctuation">)</span><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 class="symbol monospace"><div class="block"><div class="block"><span class="token annotation">@</span><span data-unresolved-link="net.fabricmc.api/Environment///PointingToDeclaration/"><span class="token annotation">Environment</span></span><span class="token punctuation">(</span><span>value<span class="token operator"> = </span><span data-unresolved-link="net.fabricmc.api/EnvType.CLIENT///PointingToDeclaration/">EnvType.CLIENT</span></span><wbr><span class="token punctuation">)</span></div></div><span class="token keyword"></span><span class="token keyword">fun </span><a href="../net.axay.fabrik.commands/-registrable-command/index.html">RegistrableCommand</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="https://maven.fabricmc.net/docs/fabric-api-0.53.4+1.19/net/fabricmc/fabric/api/client/command/v2/FabricClientCommandSource.html">FabricClientCommandSource</a><span class="token operator">&gt;</span><span class="token punctuation">.</span><a href="register.html"><span class="token function">register</span></a><span class="token punctuation">(</span><span class="token punctuation">)</span><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><p class="paragraph">Register this command (client-side).</p></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-depenent-content" data-active="" data-togglable=":fabrikmc-commands:dokkaHtmlPartial/main"><div class="symbol monospace strikethrough"><strike><span class="token keyword"></span></strike><strike><span class="token keyword">fun </span></strike><span data-unresolved-link="com.mojang.brigadier.builder/LiteralArgumentBuilder///PointingToDeclaration/">LiteralArgumentBuilder</span><span class="token operator">&lt;</span><span class="token keyword"></span><a href="https://maven.fabricmc.net/docs/fabric-api-0.55.3+1.19/net/fabricmc/fabric/api/client/command/v2/FabricClientCommandSource.html">FabricClientCommandSource</a><span class="token operator">&gt;</span><strike><span class="token punctuation">.</span></strike><a href="register.html"><strike><span class="token function">register</span></strike></a><strike><span class="token punctuation">(</span></strike><strike><span class="token punctuation">)</span></strike><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 class="symbol monospace strikethrough"><strike><span class="token keyword"></span></strike><strike><span class="token keyword">fun </span></strike><a href="../net.axay.fabrik.commands/-registrable-command/index.html">RegistrableCommand</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="https://maven.fabricmc.net/docs/fabric-api-0.55.3+1.19/net/fabricmc/fabric/api/client/command/v2/FabricClientCommandSource.html">FabricClientCommandSource</a><span class="token operator">&gt;</span><strike><span class="token punctuation">.</span></strike><a href="register.html"><strike><span class="token function">register</span></strike></a><strike><span class="token punctuation">(</span></strike><strike><span class="token punctuation">)</span></strike><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>
<h2 class="">Sources</h2>
<div class="table" data-togglable="Sources"><a data-name="407342240%2FSource%2F1397106568" anchor-label="https://github.com/jakobkmar/fabrikmc/tree/main/fabrikmc-commands/src/main/kotlin/net/axay/fabrik/commands/registration/CommandRegistration.kt#L32" id="407342240%2FSource%2F1397106568" data-filterable-set=":fabrikmc-commands:dokkaHtmlPartial/main"></a>
<div class="table" data-togglable="Sources"><a data-name="407342240%2FSource%2F1397106568" anchor-label="https://github.com/jakobkmar/fabrikmc/tree/main/fabrikmc-commands/src/main/kotlin/net/axay/fabrik/commands/registration/CommandRegistration.kt#L49" id="407342240%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">
<div><a href="https://github.com/jakobkmar/fabrikmc/tree/main/fabrikmc-commands/src/main/kotlin/net/axay/fabrik/commands/registration/CommandRegistration.kt#L32">jvm source</a></div>
<div><a href="https://github.com/jakobkmar/fabrikmc/tree/main/fabrikmc-commands/src/main/kotlin/net/axay/fabrik/commands/registration/CommandRegistration.kt#L49">jvm source</a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="407342240%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>
</div>
</div>
<a data-name="407342240%2FSource%2F1397106568" anchor-label="https://github.com/jakobkmar/fabrikmc/tree/main/fabrikmc-commands/src/main/kotlin/net/axay/fabrik/commands/registration/CommandRegistration.kt#L40" id="407342240%2FSource%2F1397106568" data-filterable-set=":fabrikmc-commands:dokkaHtmlPartial/main"></a>
<a data-name="407342240%2FSource%2F1397106568" anchor-label="https://github.com/jakobkmar/fabrikmc/tree/main/fabrikmc-commands/src/main/kotlin/net/axay/fabrik/commands/registration/CommandRegistration.kt#L55" id="407342240%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">
<div><a href="https://github.com/jakobkmar/fabrikmc/tree/main/fabrikmc-commands/src/main/kotlin/net/axay/fabrik/commands/registration/CommandRegistration.kt#L40">jvm source</a></div>
<div><a href="https://github.com/jakobkmar/fabrikmc/tree/main/fabrikmc-commands/src/main/kotlin/net/axay/fabrik/commands/registration/CommandRegistration.kt#L55">jvm source</a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="407342240%2FSource%2F1397106568"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
Expand Down
Loading

0 comments on commit 8485484

Please sign in to comment.