Skip to content

Commit

Permalink
Update Dokka docs
Browse files Browse the repository at this point in the history
  • Loading branch information
jakobkmar committed Sep 13, 2021
1 parent 0b323e3 commit a90d56e
Show file tree
Hide file tree
Showing 2,179 changed files with 176,559 additions and 232 deletions.
2 changes: 1 addition & 1 deletion docs/fabrikmc-commands/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -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.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 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.1")</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>
Expand Down
115 changes: 80 additions & 35 deletions docs/fabrikmc-commands/navigation.html

Large diffs are not rendered by default.

14 changes: 13 additions & 1 deletion docs/fabrikmc-core/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
</div>
<div class="cover ">
<h1 class="cover"><span>fabrikmc-core</span></h1>
<div class="platform-hinted UnderCoverText" data-platform-hinted="data-platform-hinted"><div class="content sourceset-depenent-content" data-active="" data-togglable=":fabrikmc-core:dokkaHtmlPartial/main"><p class="paragraph">The core module contains simple, stable and leightweight extensions for some Minecraft classes. It does not use any mixins.</p><p class="paragraph">Here you will find ItemStack builders, a Sideboard API, Position utilities and coroutine task functions.</p><h3 class=""> Dependency</h3><div class="sample-container"><code class="" theme="idea"><pre>modImplementation("net.axay:fabrikmc-core:1.3.0")</pre></code></div></div></div>
<div class="platform-hinted UnderCoverText" data-platform-hinted="data-platform-hinted"><div class="content sourceset-depenent-content" data-active="" data-togglable=":fabrikmc-core:dokkaHtmlPartial/main"><p class="paragraph">The core module contains simple, stable and leightweight extensions for some Minecraft classes. It does not use any mixins.</p><p class="paragraph">Here you will find ItemStack builders, a Sideboard API, Position utilities and coroutine task functions.</p><h3 class=""> Dependency</h3><div class="sample-container"><code class="" theme="idea"><pre>modImplementation("net.axay:fabrikmc-core:1.3.1")</pre></code></div></div></div>
</div>
<h2 class="">Packages</h2>
<div class="table"><a data-name="-1015552492%2FPackages%2F-1552142639" anchor-label="net.axay.fabrik.core" id="-1015552492%2FPackages%2F-1552142639" data-filterable-set=":fabrikmc-core:dokkaHtmlPartial/main"></a>
Expand Down Expand Up @@ -86,6 +86,18 @@ <h2 class="">Packages</h2>
<div><span class="brief-comment"><a data-name="-1287093338%2FPackages%2F-1552142639" anchor-label="net.axay.fabrik.core.math" id="-1287093338%2FPackages%2F-1552142639" data-filterable-set=":fabrikmc-core:dokkaHtmlPartial/main"></a>Conversion between different types of Locations, extensions for working with vectors</span></div>
</div>
</div>
<a data-name="-462318257%2FPackages%2F-1552142639" anchor-label="net.axay.fabrik.core.math.vector" id="-462318257%2FPackages%2F-1552142639" data-filterable-set=":fabrikmc-core:dokkaHtmlPartial/main"></a>
<div class="table-row" data-filterable-current=":fabrikmc-core:dokkaHtmlPartial/main" data-filterable-set=":fabrikmc-core:dokkaHtmlPartial/main">
<div>
<div class="main-subrow ">
<div class=""><span class="inline-flex"><a href="net.axay.fabrik.core.math.vector/index.html">net.axay.fabrik.core.math.vector</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-462318257%2FPackages%2F-1552142639"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div class="pull-right"></div>
</div>
<div></div>
</div>
</div>
<a data-name="-113939930%2FPackages%2F-1552142639" anchor-label="net.axay.fabrik.core.packet" id="-113939930%2FPackages%2F-1552142639" data-filterable-set=":fabrikmc-core:dokkaHtmlPartial/main"></a>
<div class="table-row" data-filterable-current=":fabrikmc-core:dokkaHtmlPartial/main" data-filterable-set=":fabrikmc-core:dokkaHtmlPartial/main">
<div>
Expand Down
Loading

0 comments on commit a90d56e

Please sign in to comment.