{% setvar book_path %}/reference/kotlin/dokkatest/_book.yaml{% endsetvar %} {% include "_shared/_reference-head-tags.html" %}

dokkatest.toplevel

Hello, I'm a package summary!

Classes

Foo

Annotations

Wassup

Howdy!

Type aliases

Baz

Constants summary

const Boolean
bool = true

Humpty Dumpty sat on a wall...

Top-level functions summary

Unit
a()
String
b(i1: Int?, i2: String?, i3: Boolean, foo: Foo)

Top level function docs next to a.

String
bar()
Nothing

This function is deprecated. This method was too sad.

Extension functions summary

suspend inline () -> List<Float>
@Wassup(a = "hello", f = ["world"])
<T : Any?, R : @Wassup Number> T.(@Wassup Int) -> List<@Wassup R>.foo(
    a: T,
    vararg c: Int,
    crossinline stuff: @Wassup(a = "bar") () -> Function0<String?>,
    @Wassup block: suspend Set<Boolean>.(cache: Map<String?, List<T>>, mapper: (Double?) -> Double) -> Collection<R?>
)

A brutally difficult function to render.

Top-level properties summary

Foo

Extension properties summary

Int

The Wheels on the Bus go round and round...

Constants

bool

const val bool = true: Boolean

Humpty Dumpty sat on a wall...

Top-level functions

a

fun a(): Unit

b

fun b(i1: Int?, i2: String?, i3: Boolean, foo: Foo): String

Top level function docs next to a. This is a second sentence. Talk to world.

bar

fun bar(): String

sadBoi

fun sadBoi(): Nothing

I'm so sad, they're deleting me!

Extension functions

foo

@Wassup(a = "hello", f = ["world"])
suspend inline fun <T : Any?, R : @Wassup Number> T.(@Wassup Int) -> List<@Wassup R>.foo(
    a: T,
    vararg c: Int,
    crossinline stuff: @Wassup(a = "bar") () -> Function0<String?> = { { "Nests." } },
    @Wassup block: suspend Set<Boolean>.(cache: Map<String?, List<T>>, mapper: (Double?) -> Double) -> Collection<R?>
): () -> List<Float>

A brutally difficult function to render. Good luck!

Sarcastic laugh

Parameters
T.(@Wassup Int) -> List<@Wassup R>

what is even going on here

a: T

choose your own adventure!

vararg c: Int

any number of ints

crossinline stuff: @Wassup(a = "bar") () -> Function0<String?> = { { "Nests." } }

lambdas

@Wassup block: suspend Set<Boolean>.(cache: Map<String?, List<T>>, mapper: (Double?) -> Double) -> Collection<R?>

Lots, and LOTS of lambdas. Oh, and suspending ones too.

Returns
() -> List<Float>

a list of... something?

Throws
kotlin.IllegalStateException

because the world is broken

See also
b

it's a lot simpler

Top-level properties

hello

val helloFoo

Extension properties

world

val String.worldInt

The Wheels on the Bus go round and round...