blob: 77412ba511c20172683770d545b421f49a9963d6 [file] [log] [blame]
<html devsite="true">
<head>
<title>TopKt</title>
{% setvar book_path %}/reference/dokkatest/_book.yaml{% endsetvar %}
{% include "_shared/_reference-head-tags.html" %}
</head>
<body>
<h1>TopKt</h1>
{% setvar page_path %}dokkatest/toplevel/TopKt.html{% endsetvar %}
{% setvar can_switch %}1{% endsetvar %}
{% include "reference/_java_switcher2.md" %}
<p>
<pre>public final class TopKt</pre>
</p>
<hr>
<h2>Summary</h2>
<div class="devsite-table-wrapper">
<table class="responsive">
<thead>
<tr>
<th colspan="2"><h3>Constants</h3></th>
</tr>
</thead>
<tbody>
<tr>
<td><code>final static&nbsp;final boolean</code></td>
<td width="100%">
<div><code><a href="/reference/dokkatest/toplevel/package-summary.html#bool()">bool</a></code></div>
<p>Humpty Dumpty sat on a wall...</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="devsite-table-wrapper">
<table class="responsive">
<thead>
<tr>
<th colspan="2"><h3>Public fields</h3></th>
</tr>
</thead>
<tbody>
<tr>
<td><code>final <a href="/reference/dokkatest/toplevel/Foo.html">Foo</a></code></td>
<td width="100%">
<div><code><a href="/reference/dokkatest/toplevel/package-summary.html#hello()">hello</a></code></div>
</td>
</tr>
<tr>
<td><code>final int</code></td>
<td width="100%">
<div><code><a href="/reference/dokkatest/toplevel/package-summary.html#world(kotlin.String)">world</a></code></div>
<p>The Wheels on the Bus go round and round...</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="devsite-table-wrapper">
<table class="responsive">
<thead>
<tr>
<th colspan="2"><h3>Public methods</h3></th>
</tr>
</thead>
<tbody>
<tr>
<td><code>static&nbsp;final void</code></td>
<td width="100%">
<div><code><a href="/reference/dokkatest/toplevel/TopKt.html#a()">a</a>()</code></div>
</td>
</tr>
<tr>
<td><code>static&nbsp;final <a href="https://developer.android.com/reference/java/lang/String.html">String</a></code></td>
<td width="100%">
<div><code><a href="/reference/dokkatest/toplevel/TopKt.html#b(kotlin.Int,kotlin.String,kotlin.Boolean,dokkatest.toplevel.Foo)">b</a>(@<a href="/reference/androidx/annotation/Nullable.html">Nullable</a>&nbsp;<a href="https://developer.android.com/reference/java/lang/Integer.html">Integer</a>&nbsp;i1,&nbsp;@<a href="/reference/androidx/annotation/Nullable.html">Nullable</a>&nbsp;<a href="https://developer.android.com/reference/java/lang/String.html">String</a>&nbsp;i2,&nbsp;boolean&nbsp;i3,&nbsp;<a href="/reference/dokkatest/toplevel/Foo.html">Foo</a>&nbsp;foo)</code></div>
<p>Top level function docs next to <code><a href="/reference/dokkatest/toplevel/package-summary.html#a()">a</a></code>.</p>
</td>
</tr>
<tr>
<td><code>static&nbsp;final @<a href="/reference/dokkatest/toplevel/Wassup.html">Wassup</a>(a&nbsp;=&nbsp;&quot;hello&quot;,&nbsp;f&nbsp;=&nbsp;[&quot;world&quot;])&nbsp;Function0&lt;<a href="https://developer.android.com/reference/java/util/List.html">List</a>&lt;<a href="https://developer.android.com/reference/java/lang/Float.html">Float</a>&gt;&gt;</code></td>
<td width="100%">
<div><code>&lt;T&nbsp;extends&nbsp;@<a href="/reference/androidx/annotation/Nullable.html">Nullable</a>&nbsp;<a href="https://developer.android.com/reference/java/lang/Object.html">Object</a>,&nbsp;R&nbsp;extends&nbsp;<a href="https://developer.android.com/reference/java/lang/Number.html">Number</a>&gt; <a href="/reference/dokkatest/toplevel/TopKt.html#foo(kotlin.Function2,kotlin.Any,kotlin.IntArray,kotlin.Function0,kotlin.coroutines.SuspendFunction3)">foo</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;Function2&lt;T,&nbsp;<a href="https://developer.android.com/reference/java/lang/Integer.html">Integer</a>,&nbsp;<a href="https://developer.android.com/reference/java/util/List.html">List</a>&lt;R&gt;&gt;&nbsp;receiver,<br>&nbsp;&nbsp;&nbsp;&nbsp;T&nbsp;a,<br>&nbsp;&nbsp;&nbsp;&nbsp;int&nbsp;c,<br>&nbsp;&nbsp;&nbsp;&nbsp;Function0&lt;Function0&lt;<a href="https://developer.android.com/reference/java/lang/String.html">String</a>&gt;&gt;&nbsp;stuff,<br>&nbsp;&nbsp;&nbsp;&nbsp;@<a href="/reference/dokkatest/toplevel/Wassup.html">Wassup</a>&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.coroutines/-suspend-function3/index.html">SuspendFunction3</a>&lt;<a href="https://developer.android.com/reference/java/util/Set.html">Set</a>&lt;<a href="https://developer.android.com/reference/java/lang/Boolean.html">Boolean</a>&gt;,&nbsp;<a href="https://developer.android.com/reference/java/util/Map.html">Map</a>&lt;<a href="https://developer.android.com/reference/java/lang/String.html">String</a>,&nbsp;<a href="https://developer.android.com/reference/java/util/List.html">List</a>&lt;T&gt;&gt;,&nbsp;Function1&lt;<a href="https://developer.android.com/reference/java/lang/Double.html">Double</a>,&nbsp;<a href="https://developer.android.com/reference/java/lang/Double.html">Double</a>&gt;,&nbsp;<a href="https://developer.android.com/reference/java/util/Collection.html">Collection</a>&lt;R&gt;&gt;&nbsp;block<br>)</code></div>
<p>A brutally difficult function to render.</p>
</td>
</tr>
<tr>
<td><code>static&nbsp;final <a href="https://developer.android.com/reference/java/lang/Void.html">Void</a></code></td>
<td width="100%">
<div><code><span><del><a href="/reference/dokkatest/toplevel/TopKt.html#sadBoi()">sadBoi</a></del></span>()</code></div>
<p><strong>This method is deprecated.</strong> This method was too sad.</p>
</td>
</tr>
</tbody>
</table>
</div>
<h2>Constants</h2>
<div><a name="getBool()"></a><a name="setBool()"></a><a name="getBool--"></a><a name="setBool--"></a>
<h3 class="api-name" id="bool()">bool</h3>
<pre class="api-signature no-pretty-print">public&nbsp;final&nbsp;static&nbsp;final&nbsp;boolean&nbsp;<a href="/reference/dokkatest/toplevel/package-summary.html#bool()">bool</a></pre>
<p>Humpty Dumpty sat on a wall...</p>
</div>
<h2>Public fields</h2>
<div><a name="getHello()"></a><a name="setHello()"></a><a name="getHello--"></a><a name="setHello--"></a>
<h3 class="api-name" id="hello()">hello</h3>
<pre class="api-signature no-pretty-print">public&nbsp;final&nbsp;<a href="/reference/dokkatest/toplevel/Foo.html">Foo</a>&nbsp;<a href="/reference/dokkatest/toplevel/package-summary.html#hello()">hello</a></pre>
</div>
<div><a name="getWorld(kotlin.String)"></a><a name="setWorld(kotlin.String)"></a><a name="getWorld-kotlin.String-"></a><a name="setWorld-kotlin.String-"></a>
<h3 class="api-name" id="world(kotlin.String)">world</h3>
<pre class="api-signature no-pretty-print">public&nbsp;final&nbsp;int&nbsp;<a href="/reference/dokkatest/toplevel/package-summary.html#world(kotlin.String)">world</a></pre>
<p>The Wheels on the Bus go round and round...</p>
</div>
<h2>Public methods</h2>
<div><a name="a--"></a>
<h3 class="api-name" id="a()">a</h3>
<pre class="api-signature no-pretty-print">public&nbsp;static&nbsp;final&nbsp;void&nbsp;<a href="/reference/dokkatest/toplevel/TopKt.html#a()">a</a>()</pre>
</div>
<div><a name="b(kotlin.Int, kotlin.String, kotlin.Boolean, dokkatest.toplevel.Foo)"></a><a name="b-kotlin.Int-kotlin.String-kotlin.Boolean-dokkatest.toplevel.Foo-"></a>
<h3 class="api-name" id="b(kotlin.Int,kotlin.String,kotlin.Boolean,dokkatest.toplevel.Foo)">b</h3>
<pre class="api-signature no-pretty-print">public&nbsp;static&nbsp;final&nbsp;<a href="https://developer.android.com/reference/java/lang/String.html">String</a>&nbsp;<a href="/reference/dokkatest/toplevel/TopKt.html#b(kotlin.Int,kotlin.String,kotlin.Boolean,dokkatest.toplevel.Foo)">b</a>(@<a href="/reference/androidx/annotation/Nullable.html">Nullable</a>&nbsp;<a href="https://developer.android.com/reference/java/lang/Integer.html">Integer</a>&nbsp;i1,&nbsp;@<a href="/reference/androidx/annotation/Nullable.html">Nullable</a>&nbsp;<a href="https://developer.android.com/reference/java/lang/String.html">String</a>&nbsp;i2,&nbsp;boolean&nbsp;i3,&nbsp;<a href="/reference/dokkatest/toplevel/Foo.html">Foo</a>&nbsp;foo)</pre>
<p>Top level function docs next to <code><a href="/reference/dokkatest/toplevel/package-summary.html#a()">a</a></code>. This is a second sentence. Talk to <code><a href="/reference/dokkatest/toplevel/package-summary.html#world(kotlin.String)">world</a></code>.</p>
</div>
<div><a name="foo(kotlin.Function2, kotlin.Any, kotlin.IntArray, kotlin.Function0, kotlin.coroutines.SuspendFunction3)"></a><a name="foo-kotlin.Function2-kotlin.Any-kotlin.IntArray-kotlin.Function0-kotlin.coroutines.SuspendFunction3-"></a>
<h3 class="api-name" id="foo(kotlin.Function2,kotlin.Any,kotlin.IntArray,kotlin.Function0,kotlin.coroutines.SuspendFunction3)">foo</h3>
<pre class="api-signature no-pretty-print">@<a href="/reference/dokkatest/toplevel/Wassup.html">Wassup</a>(a&nbsp;=&nbsp;&quot;hello&quot;,&nbsp;f&nbsp;=&nbsp;[&quot;world&quot;])<br>public&nbsp;static&nbsp;final&nbsp;@<a href="/reference/dokkatest/toplevel/Wassup.html">Wassup</a>(a&nbsp;=&nbsp;&quot;hello&quot;,&nbsp;f&nbsp;=&nbsp;[&quot;world&quot;])&nbsp;Function0&lt;<a href="https://developer.android.com/reference/java/util/List.html">List</a>&lt;<a href="https://developer.android.com/reference/java/lang/Float.html">Float</a>&gt;&gt;&nbsp;&lt;T&nbsp;extends&nbsp;@<a href="/reference/androidx/annotation/Nullable.html">Nullable</a>&nbsp;<a href="https://developer.android.com/reference/java/lang/Object.html">Object</a>,&nbsp;R&nbsp;extends&nbsp;<a href="https://developer.android.com/reference/java/lang/Number.html">Number</a>&gt; <a href="/reference/dokkatest/toplevel/TopKt.html#foo(kotlin.Function2,kotlin.Any,kotlin.IntArray,kotlin.Function0,kotlin.coroutines.SuspendFunction3)">foo</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;Function2&lt;T,&nbsp;<a href="https://developer.android.com/reference/java/lang/Integer.html">Integer</a>,&nbsp;<a href="https://developer.android.com/reference/java/util/List.html">List</a>&lt;R&gt;&gt;&nbsp;receiver,<br>&nbsp;&nbsp;&nbsp;&nbsp;T&nbsp;a,<br>&nbsp;&nbsp;&nbsp;&nbsp;int&nbsp;c,<br>&nbsp;&nbsp;&nbsp;&nbsp;Function0&lt;Function0&lt;<a href="https://developer.android.com/reference/java/lang/String.html">String</a>&gt;&gt;&nbsp;stuff,<br>&nbsp;&nbsp;&nbsp;&nbsp;@<a href="/reference/dokkatest/toplevel/Wassup.html">Wassup</a>&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.coroutines/-suspend-function3/index.html">SuspendFunction3</a>&lt;<a href="https://developer.android.com/reference/java/util/Set.html">Set</a>&lt;<a href="https://developer.android.com/reference/java/lang/Boolean.html">Boolean</a>&gt;,&nbsp;<a href="https://developer.android.com/reference/java/util/Map.html">Map</a>&lt;<a href="https://developer.android.com/reference/java/lang/String.html">String</a>,&nbsp;<a href="https://developer.android.com/reference/java/util/List.html">List</a>&lt;T&gt;&gt;,&nbsp;Function1&lt;<a href="https://developer.android.com/reference/java/lang/Double.html">Double</a>,&nbsp;<a href="https://developer.android.com/reference/java/lang/Double.html">Double</a>&gt;,&nbsp;<a href="https://developer.android.com/reference/java/util/Collection.html">Collection</a>&lt;R&gt;&gt;&nbsp;block<br>)</pre>
<p>A brutally difficult function to render. Good luck!</p>
<p><img alt="Sarcastic laugh" src="https://thumbs.gfycat.com/BothFabulousHarvestmen-size_restricted.gif"></p>
<div class="devsite-table-wrapper">
<table class="responsive">
<thead>
<tr>
<th colspan="2">Returns</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>@<a href="/reference/dokkatest/toplevel/Wassup.html">Wassup</a>(a&nbsp;=&nbsp;&quot;hello&quot;,&nbsp;f&nbsp;=&nbsp;[&quot;world&quot;])&nbsp;Function0&lt;<a href="https://developer.android.com/reference/java/util/List.html">List</a>&lt;<a href="https://developer.android.com/reference/java/lang/Float.html">Float</a>&gt;&gt;</code></td>
<td width="100%">
<p>a list of... something?</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="devsite-table-wrapper">
<table class="responsive">
<thead>
<tr>
<th colspan="2">Parameters</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>Function2&lt;T,&nbsp;<a href="https://developer.android.com/reference/java/lang/Integer.html">Integer</a>,&nbsp;<a href="https://developer.android.com/reference/java/util/List.html">List</a>&lt;R&gt;&gt;&nbsp;receiver</code></td>
<td width="100%">
<p>what is even going on here</p>
</td>
</tr>
<tr>
<td><code>T&nbsp;a</code></td>
<td width="100%">
<p>choose your own adventure!</p>
</td>
</tr>
<tr>
<td><code>int&nbsp;c</code></td>
<td width="100%">
<p>any number of ints</p>
</td>
</tr>
<tr>
<td><code>Function0&lt;Function0&lt;<a href="https://developer.android.com/reference/java/lang/String.html">String</a>&gt;&gt;&nbsp;stuff</code></td>
<td width="100%">
<p>lambdas</p>
</td>
</tr>
<tr>
<td><code>@<a href="/reference/dokkatest/toplevel/Wassup.html">Wassup</a>&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.coroutines/-suspend-function3/index.html">SuspendFunction3</a>&lt;<a href="https://developer.android.com/reference/java/util/Set.html">Set</a>&lt;<a href="https://developer.android.com/reference/java/lang/Boolean.html">Boolean</a>&gt;,&nbsp;<a href="https://developer.android.com/reference/java/util/Map.html">Map</a>&lt;<a href="https://developer.android.com/reference/java/lang/String.html">String</a>,&nbsp;<a href="https://developer.android.com/reference/java/util/List.html">List</a>&lt;T&gt;&gt;,&nbsp;Function1&lt;<a href="https://developer.android.com/reference/java/lang/Double.html">Double</a>,&nbsp;<a href="https://developer.android.com/reference/java/lang/Double.html">Double</a>&gt;,&nbsp;<a href="https://developer.android.com/reference/java/util/Collection.html">Collection</a>&lt;R&gt;&gt;&nbsp;block</code></td>
<td width="100%">
<p>Lots, and LOTS of lambdas. Oh, and suspending ones too.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="devsite-table-wrapper">
<table class="responsive">
<thead>
<tr>
<th colspan="2">Throws</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>kotlin.IllegalStateException</code></td>
<td width="100%">
<p>because the world is broken</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="devsite-table-wrapper">
<table class="responsive">
<thead>
<tr>
<th colspan="2">See also</th>
</tr>
</thead>
<tbody>
<tr>
<td><code><a href="/reference/dokkatest/toplevel/package-summary.html#b(kotlin.Int,kotlin.String,kotlin.Boolean,dokkatest.toplevel.Foo)">b</a></code></td>
<td width="100%">
<p>it's a lot simpler</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div><a name="sadBoi--"></a>
<h3 class="api-name" id="sadBoi()">sadBoi</h3>
<pre class="api-signature no-pretty-print">public&nbsp;static&nbsp;final&nbsp;<a href="https://developer.android.com/reference/java/lang/Void.html">Void</a>&nbsp;<span><del><a href="/reference/dokkatest/toplevel/TopKt.html#sadBoi()">sadBoi</a></del></span>()</pre>
<aside class="caution"><strong>This method is deprecated.</strong><br>This method was too sad.</aside>
<p>I'm so sad, they're deleting me!</p>
</div>
</body>
</html>