Skip to content

Commit

Permalink
Generate dokka
Browse files Browse the repository at this point in the history
  • Loading branch information
ajalt committed Apr 10, 2018
1 parent 999b0a8 commit e1c5ba8
Show file tree
Hide file tree
Showing 36 changed files with 206 additions and 105 deletions.
3 changes: 2 additions & 1 deletion docs/api/clikt/alltypes/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -152,7 +152,7 @@ <h3>All Types</h3>
<td>
<a href="../com.github.ajalt.clikt.core/-no-run-clikt-command/index.html">com.github.ajalt.clikt.core.NoRunCliktCommand</a></td>
<td>
<p>A <a href="../com.github.ajalt.clikt.core/-clikt-command/index.html">CliktCommand</a> that has a default implementation of <a href="run">CliktCommand.run</a>.</p>
<p>A <a href="../com.github.ajalt.clikt.core/-clikt-command/index.html">CliktCommand</a> that has a default implementation of <a href="../com.github.ajalt.clikt.core/-clikt-command/run.html">CliktCommand.run</a> that is a no-op.</p>
</td>
</tr>
<tr>
Expand Down Expand Up @@ -248,6 +248,7 @@ <h3>All Types</h3>
<td>
<a href="../com.github.ajalt.clikt.parameters.arguments/-processed-argument/index.html">com.github.ajalt.clikt.parameters.arguments.ProcessedArgument</a></td>
<td>
<p>An <a href="../com.github.ajalt.clikt.parameters.arguments/-argument/index.html">Argument</a> delegate implementation that transforms its values .</p>
</td>
</tr>
<tr>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -210,7 +210,7 @@ <h3>Extension Functions</h3>
<code><span class="keyword">fun </span><span class="symbol">&lt;</span><span class="identifier">T</span>&nbsp;<span class="symbol">:</span>&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html"><span class="identifier">Any</span></a><span class="symbol">&gt;</span> <a href="./index.html"><span class="identifier">CliktCommand</span></a><span class="symbol">.</span><span class="identifier">findObject</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.properties/-read-only-property/index.html"><span class="identifier">ReadOnlyProperty</span></a><span class="symbol">&lt;</span><a href="./index.html"><span class="identifier">CliktCommand</span></a><span class="symbol">,</span>&nbsp;<a href="../find-object.html#T"><span class="identifier">T</span></a><span class="symbol">?</span><span class="symbol">&gt;</span></code>
<p>Find the closest object of type <a href="../find-object.html#T">T</a>, or null</p>
<code><span class="keyword">fun </span><span class="symbol">&lt;</span><span class="identifier">T</span>&nbsp;<span class="symbol">:</span>&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html"><span class="identifier">Any</span></a><span class="symbol">&gt;</span> <a href="./index.html"><span class="identifier">CliktCommand</span></a><span class="symbol">.</span><span class="identifier">findObject</span><span class="symbol">(</span><span class="identifier" id="com.github.ajalt.clikt.core$findObject(com.github.ajalt.clikt.core.CliktCommand, kotlin.Function0((com.github.ajalt.clikt.core.findObject.T)))/default">default</span><span class="symbol">:</span>&nbsp;<span class="symbol">(</span><span class="symbol">)</span>&nbsp;<span class="symbol">-&gt;</span>&nbsp;<a href="../find-object.html#T"><span class="identifier">T</span></a><span class="symbol">)</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.properties/-read-only-property/index.html"><span class="identifier">ReadOnlyProperty</span></a><span class="symbol">&lt;</span><a href="./index.html"><span class="identifier">CliktCommand</span></a><span class="symbol">,</span>&nbsp;<a href="../find-object.html#T"><span class="identifier">T</span></a><span class="symbol">&gt;</span></code>
<p>Find the closest object of type <a href="../find-object.html#T">T</a>, setting <code>context.</code><a href="#">obj</a> if one is not found.</p>
<p>Find the closest object of type <a href="../find-object.html#T">T</a>, setting <code>context.obj</code> if one is not found.</p>
</td>
</tr>
<tr>
Expand Down Expand Up @@ -261,7 +261,7 @@ <h3>Inheritors</h3>
</td>
<td>
<code><span class="keyword">open</span> <span class="keyword">class </span><span class="identifier">NoRunCliktCommand</span>&nbsp;<span class="symbol">:</span>&nbsp;<a href="./index.html"><span class="identifier">CliktCommand</span></a></code>
<p>A <a href="./index.html">CliktCommand</a> that has a default implementation of <a href="run">CliktCommand.run</a>.</p>
<p>A <a href="./index.html">CliktCommand</a> that has a default implementation of <a href="run.html">CliktCommand.run</a> that is a no-op.</p>
</td>
</tr>
</tbody>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,6 @@
<h1>&lt;init&gt;</h1>
<a name="com.github.ajalt.clikt.core.NoRunCliktCommand$&lt;init&gt;(kotlin.String, kotlin.String, kotlin.String)"></a>
<code><span class="identifier">NoRunCliktCommand</span><span class="symbol">(</span><span class="identifier" id="com.github.ajalt.clikt.core.NoRunCliktCommand$<init>(kotlin.String, kotlin.String, kotlin.String)/help">help</span><span class="symbol">:</span>&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a>&nbsp;<span class="symbol">=</span>&nbsp;""<span class="symbol">, </span><span class="identifier" id="com.github.ajalt.clikt.core.NoRunCliktCommand$<init>(kotlin.String, kotlin.String, kotlin.String)/epilog">epilog</span><span class="symbol">:</span>&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a>&nbsp;<span class="symbol">=</span>&nbsp;""<span class="symbol">, </span><span class="identifier" id="com.github.ajalt.clikt.core.NoRunCliktCommand$<init>(kotlin.String, kotlin.String, kotlin.String)/name">name</span><span class="symbol">:</span>&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a><span class="symbol">?</span>&nbsp;<span class="symbol">=</span>&nbsp;null<span class="symbol">)</span></code>
<p>A <a href="../-clikt-command/index.html">CliktCommand</a> that has a default implementation of <a href="run">CliktCommand.run</a>.</p>
<p>A <a href="../-clikt-command/index.html">CliktCommand</a> that has a default implementation of <a href="../-clikt-command/run.html">CliktCommand.run</a> that is a no-op.</p>
</BODY>
</HTML>
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
<br/>
<h1>NoRunCliktCommand</h1>
<code><span class="keyword">open</span> <span class="keyword">class </span><span class="identifier">NoRunCliktCommand</span>&nbsp;<span class="symbol">:</span>&nbsp;<a href="../-clikt-command/index.html"><span class="identifier">CliktCommand</span></a></code>
<p>A <a href="../-clikt-command/index.html">CliktCommand</a> that has a default implementation of <a href="run">CliktCommand.run</a>.</p>
<p>A <a href="../-clikt-command/index.html">CliktCommand</a> that has a default implementation of <a href="../-clikt-command/run.html">CliktCommand.run</a> that is a no-op.</p>
<h3>Constructors</h3>
<table>
<tbody>
Expand All @@ -19,7 +19,7 @@ <h3>Constructors</h3>
</td>
<td>
<code><span class="identifier">NoRunCliktCommand</span><span class="symbol">(</span><span class="identifier" id="com.github.ajalt.clikt.core.NoRunCliktCommand$<init>(kotlin.String, kotlin.String, kotlin.String)/help">help</span><span class="symbol">:</span>&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a>&nbsp;<span class="symbol">=</span>&nbsp;""<span class="symbol">, </span><span class="identifier" id="com.github.ajalt.clikt.core.NoRunCliktCommand$<init>(kotlin.String, kotlin.String, kotlin.String)/epilog">epilog</span><span class="symbol">:</span>&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a>&nbsp;<span class="symbol">=</span>&nbsp;""<span class="symbol">, </span><span class="identifier" id="com.github.ajalt.clikt.core.NoRunCliktCommand$<init>(kotlin.String, kotlin.String, kotlin.String)/name">name</span><span class="symbol">:</span>&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a><span class="symbol">?</span>&nbsp;<span class="symbol">=</span>&nbsp;null<span class="symbol">)</span></code>
<p>A <a href="../-clikt-command/index.html">CliktCommand</a> that has a default implementation of <a href="run">CliktCommand.run</a>.</p>
<p>A <a href="../-clikt-command/index.html">CliktCommand</a> that has a default implementation of <a href="../-clikt-command/run.html">CliktCommand.run</a> that is a no-op.</p>
</td>
</tr>
</tbody>
Expand Down Expand Up @@ -189,7 +189,7 @@ <h3>Extension Functions</h3>
<code><span class="keyword">fun </span><span class="symbol">&lt;</span><span class="identifier">T</span>&nbsp;<span class="symbol">:</span>&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html"><span class="identifier">Any</span></a><span class="symbol">&gt;</span> <a href="../-clikt-command/index.html"><span class="identifier">CliktCommand</span></a><span class="symbol">.</span><span class="identifier">findObject</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.properties/-read-only-property/index.html"><span class="identifier">ReadOnlyProperty</span></a><span class="symbol">&lt;</span><a href="../-clikt-command/index.html"><span class="identifier">CliktCommand</span></a><span class="symbol">,</span>&nbsp;<a href="../find-object.html#T"><span class="identifier">T</span></a><span class="symbol">?</span><span class="symbol">&gt;</span></code>
<p>Find the closest object of type <a href="../find-object.html#T">T</a>, or null</p>
<code><span class="keyword">fun </span><span class="symbol">&lt;</span><span class="identifier">T</span>&nbsp;<span class="symbol">:</span>&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html"><span class="identifier">Any</span></a><span class="symbol">&gt;</span> <a href="../-clikt-command/index.html"><span class="identifier">CliktCommand</span></a><span class="symbol">.</span><span class="identifier">findObject</span><span class="symbol">(</span><span class="identifier" id="com.github.ajalt.clikt.core$findObject(com.github.ajalt.clikt.core.CliktCommand, kotlin.Function0((com.github.ajalt.clikt.core.findObject.T)))/default">default</span><span class="symbol">:</span>&nbsp;<span class="symbol">(</span><span class="symbol">)</span>&nbsp;<span class="symbol">-&gt;</span>&nbsp;<a href="../find-object.html#T"><span class="identifier">T</span></a><span class="symbol">)</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.properties/-read-only-property/index.html"><span class="identifier">ReadOnlyProperty</span></a><span class="symbol">&lt;</span><a href="../-clikt-command/index.html"><span class="identifier">CliktCommand</span></a><span class="symbol">,</span>&nbsp;<a href="../find-object.html#T"><span class="identifier">T</span></a><span class="symbol">&gt;</span></code>
<p>Find the closest object of type <a href="../find-object.html#T">T</a>, setting <code>context.</code><a href="#">obj</a> if one is not found.</p>
<p>Find the closest object of type <a href="../find-object.html#T">T</a>, setting <code>context.obj</code> if one is not found.</p>
</td>
</tr>
<tr>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,6 @@ <h1>findObject</h1>
<p>Find the closest object of type <a href="find-object.html#T">T</a>, or null</p>
<a name="com.github.ajalt.clikt.core$findObject(com.github.ajalt.clikt.core.CliktCommand, kotlin.Function0((com.github.ajalt.clikt.core.findObject.T)))"></a>
<code><span class="keyword">inline</span> <span class="keyword">fun </span><span class="symbol">&lt;</span><span class="keyword">reified</span>&nbsp;<span class="identifier">T</span>&nbsp;<span class="symbol">:</span>&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html"><span class="identifier">Any</span></a><span class="symbol">&gt;</span> <a href="-clikt-command/index.html"><span class="identifier">CliktCommand</span></a><span class="symbol">.</span><span class="identifier">findObject</span><span class="symbol">(</span><span class="keyword">crossinline</span> <span class="identifier" id="com.github.ajalt.clikt.core$findObject(com.github.ajalt.clikt.core.CliktCommand, kotlin.Function0((com.github.ajalt.clikt.core.findObject.T)))/default">default</span><span class="symbol">:</span>&nbsp;<span class="symbol">(</span><span class="symbol">)</span>&nbsp;<span class="symbol">-&gt;</span>&nbsp;<a href="find-object.html#T"><span class="identifier">T</span></a><span class="symbol">)</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.properties/-read-only-property/index.html"><span class="identifier">ReadOnlyProperty</span></a><span class="symbol">&lt;</span><a href="-clikt-command/index.html"><span class="identifier">CliktCommand</span></a><span class="symbol">,</span>&nbsp;<a href="find-object.html#T"><span class="identifier">T</span></a><span class="symbol">&gt;</span></code>
<p>Find the closest object of type <a href="find-object.html#T">T</a>, setting <code>context.</code><a href="#">obj</a> if one is not found.</p>
<p>Find the closest object of type <a href="find-object.html#T">T</a>, setting <code>context.obj</code> if one is not found.</p>
</BODY>
</HTML>
4 changes: 2 additions & 2 deletions docs/api/clikt/com.github.ajalt.clikt.core/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ <h3>Types</h3>
</td>
<td>
<code><span class="keyword">open</span> <span class="keyword">class </span><span class="identifier">NoRunCliktCommand</span>&nbsp;<span class="symbol">:</span>&nbsp;<a href="-clikt-command/index.html"><span class="identifier">CliktCommand</span></a></code>
<p>A <a href="-clikt-command/index.html">CliktCommand</a> that has a default implementation of <a href="run">CliktCommand.run</a>.</p>
<p>A <a href="-clikt-command/index.html">CliktCommand</a> that has a default implementation of <a href="-clikt-command/run.html">CliktCommand.run</a> that is a no-op.</p>
</td>
</tr>
</tbody>
Expand Down Expand Up @@ -155,7 +155,7 @@ <h3>Functions</h3>
<code><span class="keyword">fun </span><span class="symbol">&lt;</span><span class="identifier">T</span>&nbsp;<span class="symbol">:</span>&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html"><span class="identifier">Any</span></a><span class="symbol">&gt;</span> <a href="-clikt-command/index.html"><span class="identifier">CliktCommand</span></a><span class="symbol">.</span><span class="identifier">findObject</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.properties/-read-only-property/index.html"><span class="identifier">ReadOnlyProperty</span></a><span class="symbol">&lt;</span><a href="-clikt-command/index.html"><span class="identifier">CliktCommand</span></a><span class="symbol">,</span>&nbsp;<a href="find-object.html#T"><span class="identifier">T</span></a><span class="symbol">?</span><span class="symbol">&gt;</span></code>
<p>Find the closest object of type <a href="find-object.html#T">T</a>, or null</p>
<code><span class="keyword">fun </span><span class="symbol">&lt;</span><span class="identifier">T</span>&nbsp;<span class="symbol">:</span>&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html"><span class="identifier">Any</span></a><span class="symbol">&gt;</span> <a href="-clikt-command/index.html"><span class="identifier">CliktCommand</span></a><span class="symbol">.</span><span class="identifier">findObject</span><span class="symbol">(</span><span class="identifier" id="com.github.ajalt.clikt.core$findObject(com.github.ajalt.clikt.core.CliktCommand, kotlin.Function0((com.github.ajalt.clikt.core.findObject.T)))/default">default</span><span class="symbol">:</span>&nbsp;<span class="symbol">(</span><span class="symbol">)</span>&nbsp;<span class="symbol">-&gt;</span>&nbsp;<a href="find-object.html#T"><span class="identifier">T</span></a><span class="symbol">)</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.properties/-read-only-property/index.html"><span class="identifier">ReadOnlyProperty</span></a><span class="symbol">&lt;</span><a href="-clikt-command/index.html"><span class="identifier">CliktCommand</span></a><span class="symbol">,</span>&nbsp;<a href="find-object.html#T"><span class="identifier">T</span></a><span class="symbol">&gt;</span></code>
<p>Find the closest object of type <a href="find-object.html#T">T</a>, setting <code>context.</code><a href="#">obj</a> if one is not found.</p>
<p>Find the closest object of type <a href="find-object.html#T">T</a>, setting <code>context.obj</code> if one is not found.</p>
</td>
</tr>
<tr>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,8 @@ <h3>Parameters</h3>
<p><a name="env"></a>
<code>env</code> - Environment variables to forward to the editor.</p>
<p><a name="requireSave"></a>
<code>requireSave</code> - If true, null will be returned if the editor is closed without saving.</p>
<code>requireSave</code> - If the editor is closed without saving, null will be returned if true, otherwise
<a href="edit-text.html#com.github.ajalt.clikt.output.TermUi$editText(kotlin.String, kotlin.String, kotlin.collections.Map((kotlin.String, )), kotlin.Boolean, kotlin.String)/text">text</a> will be returned.</p>
<p><a name="extension"></a>
<code>extension</code> - The extension of the temporary file that the editor will open. This can affect syntax
coloring etc.</p>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,9 @@ <h3>Inheritors</h3>
<p><a href="../-processed-argument/index.html">ProcessedArgument</a></p>
</td>
<td>
<code><span class="keyword">class </span><span class="identifier">ProcessedArgument</span><span class="symbol">&lt;</span><span class="identifier">AllT</span><span class="symbol">, </span><span class="identifier">ValueT</span><span class="symbol">&gt;</span>&nbsp;<span class="symbol">:</span>&nbsp;<a href="./index.html"><span class="identifier">ArgumentDelegate</span></a><span class="symbol">&lt;</span><a href="../-processed-argument/index.html#AllT"><span class="identifier">AllT</span></a><span class="symbol">&gt;</span></code></td>
<code><span class="keyword">class </span><span class="identifier">ProcessedArgument</span><span class="symbol">&lt;</span><span class="identifier">AllT</span><span class="symbol">, </span><span class="identifier">ValueT</span><span class="symbol">&gt;</span>&nbsp;<span class="symbol">:</span>&nbsp;<a href="./index.html"><span class="identifier">ArgumentDelegate</span></a><span class="symbol">&lt;</span><a href="../-processed-argument/index.html#AllT"><span class="identifier">AllT</span></a><span class="symbol">&gt;</span></code>
<p>An <a href="../-argument/index.html">Argument</a> delegate implementation that transforms its values .</p>
</td>
</tr>
</tbody>
</table>
Expand Down
Loading

0 comments on commit e1c5ba8

Please sign in to comment.