opensavvy.dokka.material.mkdocs.example

This is the description of a package.

The description may be arbitrary long, but only the first paragraph is displayed in the module page. Therefore, this sentence doesn't appear in the module page, but does appear in the paragraph page.

Types

Example

class Example : MyInterface

This class is an example to see how the documentation website is generated.

ExampleAlias

typealias ExampleAlias = Example

This is a typealias.

MyInterface

sealed interface MyInterface

Simple interface.

Properties

Functions

anotherTopLevelFunction

fun anotherTopLevelFunction(
    param1: String, 
    param2: Int, 
    param3: Boolean, 
    param4: String = "default", 
    onAction: () -> Unit
): Int

This is another top-level function with multiple parameters.

topLevelFunction

fun topLevelFunction(): Int

This is a top-level function.