Contribute Dokkatoo (#3188)

38 files changed, 549 insertions, 0 deletions

diff --git a/dokka-runners/dokkatoo/examples/multiplatform-example/dokka/README.md b/dokka-runners/dokkatoo/examples/multiplatform-example/dokka/README.md
new file mode 100644
index 00000000..9b8a85e6
--- /dev/null
+++ b/dokka-runners/dokkatoo/examples/multiplatform-example/dokka/README.md
@@ -0,0 +1,29 @@
+# Dokka Multiplatform example
+
+This example demonstrates Dokka's configuration and output for a simple 
+[Kotlin Multiplatform](https://kotlinlang.org/docs/multiplatform.html) project.
+
+It contains [Kotlin source sets](https://kotlinlang.org/docs/multiplatform-discover-project.html#source-sets) for different
+platforms that are automatically picked up by Dokka from the Kotlin Gradle Plugin, and an additional custom source
+set known to Dokka only.
+
+The example demonstrates the following things:
+
+* Documentation for common code
+* Documentation for expect/actual declarations available via tabs
+* Documentation for platform-specific declarations, including functions from different source sets, but 
+  with clashing names
+* Use of Platform-specific API, such as `CPointer` from `kotlinx.cinterop`
+
+You can see up-to-date documentation generated for this example on
+[GitHub Pages](https://kotlin.github.io/dokka/examples/dokka-multiplatform-example/html/index.html).
+
+![screenshot demonstration of output](demo.png)
+
+### Running
+
+Run `dokkaHtml` task in order to generate documentation for this example:
+
+```bash
+./gradlew dokkaHtml
+```
diff --git a/dokka-runners/dokkatoo/examples/multiplatform-example/dokka/build.gradle.kts b/dokka-runners/dokkatoo/examples/multiplatform-example/dokka/build.gradle.kts
new file mode 100644
index 00000000..7c5f11cf
--- /dev/null
+++ b/dokka-runners/dokkatoo/examples/multiplatform-example/dokka/build.gradle.kts
@@ -0,0 +1,42 @@
+@file:Suppress("UNUSED_VARIABLE")
+
+import org.jetbrains.dokka.gradle.DokkaTask
+import org.jetbrains.dokka.Platform
+
+plugins {
+    kotlin("multiplatform") version "1.9.0"
+    id("org.jetbrains.dokka") version "1.9.0"
+}
+
+repositories {
+    mavenCentral()
+}
+
+group = "org.dokka.example"
+version = "1.0-SNAPSHOT"
+
+kotlin {
+    jvm() // Creates a JVM target with the default name "jvm"
+    linuxX64("linux")
+    macosX64("macos")
+    js()
+    sourceSets {
+        val commonMain by getting {
+            dependencies {
+                implementation(kotlin("stdlib-common"))
+                implementation("org.jetbrains.kotlinx:kotlinx-coroutines-core:1.5.1")
+            }
+        }
+    }
+}
+
+tasks.withType<DokkaTask>().configureEach {
+    dokkaSourceSets {
+        // Create a custom source set not known to the Kotlin Gradle Plugin
+        register("customSourceSet") {
+            this.jdkVersion.set(9)
+            this.displayName.set("custom")
+            this.sourceRoots.from(file("src/customJdk9/kotlin"))
+        }
+    }
+}
diff --git a/dokka-runners/dokkatoo/examples/multiplatform-example/dokka/demo.png b/dokka-runners/dokkatoo/examples/multiplatform-example/dokka/demo.png
new file mode 100644
index 00000000..58798ccf
--- /dev/null
+++ b/dokka-runners/dokkatoo/examples/multiplatform-example/dokka/demo.png
diff --git a/dokka-runners/dokkatoo/examples/multiplatform-example/dokka/settings.gradle.kts b/dokka-runners/dokkatoo/examples/multiplatform-example/dokka/settings.gradle.kts
new file mode 100644
index 00000000..e9daf094
--- /dev/null
+++ b/dokka-runners/dokkatoo/examples/multiplatform-example/dokka/settings.gradle.kts
@@ -0,0 +1,2 @@
+rootProject.name = "dokka-multiplatform-example"
+
diff --git a/dokka-runners/dokkatoo/examples/multiplatform-example/dokka/src/commonMain/kotlin/org/kotlintestmpp/CommonCoroutineExtensions.kt b/dokka-runners/dokkatoo/examples/multiplatform-example/dokka/src/commonMain/kotlin/org/kotlintestmpp/CommonCoroutineExtensions.kt
new file mode 100644
index 00000000..30bea657
--- /dev/null
+++ b/dokka-runners/dokkatoo/examples/multiplatform-example/dokka/src/commonMain/kotlin/org/kotlintestmpp/CommonCoroutineExtensions.kt
@@ -0,0 +1,15 @@
+package org.kotlintestmpp.coroutines
+
+import kotlinx.coroutines.CoroutineScope
+import kotlinx.coroutines.CoroutineDispatcher
+import kotlinx.coroutines.Deferred
+
+/**
+ * Common `expect` declaration
+ */
+expect fun <T> CoroutineScope.asyncWithDealy(delay: Long, block: suspend () -> T): Deferred<T>
+
+/**
+ * Common coroutine extension
+ */
+fun CoroutineDispatcher.name(): String = TODO("Not implemented")
diff --git a/dokka-runners/dokkatoo/examples/multiplatform-example/dokka/src/commonMain/kotlin/org/kotlintestmpp/CommonDateUtils.kt b/dokka-runners/dokkatoo/examples/multiplatform-example/dokka/src/commonMain/kotlin/org/kotlintestmpp/CommonDateUtils.kt
new file mode 100644
index 00000000..b241f5ea
--- /dev/null
+++ b/dokka-runners/dokkatoo/examples/multiplatform-example/dokka/src/commonMain/kotlin/org/kotlintestmpp/CommonDateUtils.kt
@@ -0,0 +1,14 @@
+package org.kotlintestmpp.date
+
+/**
+ * Common `expect` declaration
+ */
+expect fun getCurrentDate(): String
+
+/**
+ * Common date util function
+ */
+fun getDate(): String {
+    return "Today's Date is ${getCurrentDate()}"
+}
+
diff --git a/dokka-runners/dokkatoo/examples/multiplatform-example/dokka/src/commonMain/kotlin/org/kotlintestmpp/common/Foo.kt b/dokka-runners/dokkatoo/examples/multiplatform-example/dokka/src/commonMain/kotlin/org/kotlintestmpp/common/Foo.kt
new file mode 100644
index 00000000..96c825c5
--- /dev/null
+++ b/dokka-runners/dokkatoo/examples/multiplatform-example/dokka/src/commonMain/kotlin/org/kotlintestmpp/common/Foo.kt
@@ -0,0 +1,7 @@
+package org.kotlintestmpp.common
+
+/**
+ * Common Foo class
+ */
+class Foo {}
+
diff --git a/dokka-runners/dokkatoo/examples/multiplatform-example/dokka/src/customJdk9/kotlin/org/kotlintest/jdk9/CustomSourceSetFile.kt b/dokka-runners/dokkatoo/examples/multiplatform-example/dokka/src/customJdk9/kotlin/org/kotlintest/jdk9/CustomSourceSetFile.kt
new file mode 100644
index 00000000..d77b959b
--- /dev/null
+++ b/dokka-runners/dokkatoo/examples/multiplatform-example/dokka/src/customJdk9/kotlin/org/kotlintest/jdk9/CustomSourceSetFile.kt
@@ -0,0 +1,11 @@
+package org.kotlintest.jdk9
+
+/**
+ * This class demonstrates custom dokka source sets
+ */
+class CustomSourceSetFile {
+    /**
+     * This function will not do anything
+     */
+    fun thisIsAFunction() {}
+}
diff --git a/dokka-runners/dokkatoo/examples/multiplatform-example/dokka/src/jsMain/kotlin/org/kotlintestmpp/JsCoroutineExtensions.kt b/dokka-runners/dokkatoo/examples/multiplatform-example/dokka/src/jsMain/kotlin/org/kotlintestmpp/JsCoroutineExtensions.kt
new file mode 100644
index 00000000..85d6beb0
--- /dev/null
+++ b/dokka-runners/dokkatoo/examples/multiplatform-example/dokka/src/jsMain/kotlin/org/kotlintestmpp/JsCoroutineExtensions.kt
@@ -0,0 +1,11 @@
+package org.kotlintestmpp.coroutines
+
+import kotlinx.coroutines.CoroutineScope
+import kotlinx.coroutines.Deferred
+
+/**
+ * JS actual implementation for `asyncWithDelay`
+ */
+actual fun <T> CoroutineScope.asyncWithDealy(delay: Long, block: suspend () -> T): Deferred<T> {
+    TODO("Not yet implemented")
+}
diff --git a/dokka-runners/dokkatoo/examples/multiplatform-example/dokka/src/jsMain/kotlin/org/kotlintestmpp/JsDateUtils.kt b/dokka-runners/dokkatoo/examples/multiplatform-example/dokka/src/jsMain/kotlin/org/kotlintestmpp/JsDateUtils.kt
new file mode 100644
index 00000000..2f4f3c45
--- /dev/null
+++ b/dokka-runners/dokkatoo/examples/multiplatform-example/dokka/src/jsMain/kotlin/org/kotlintestmpp/JsDateUtils.kt
@@ -0,0 +1,8 @@
+package org.kotlintestmpp.date
+
+/**
+ * JS actual implementation for `getCurrentDate`
+ */
+actual fun getCurrentDate(): String {
+    return "test"
+}
diff --git a/dokka-runners/dokkatoo/examples/multiplatform-example/dokka/src/jsMain/kotlin/org/kotlintestmpp/JsFunctions.kt b/dokka-runners/dokkatoo/examples/multiplatform-example/dokka/src/jsMain/kotlin/org/kotlintestmpp/JsFunctions.kt
new file mode 100644
index 00000000..76757359
--- /dev/null
+++ b/dokka-runners/dokkatoo/examples/multiplatform-example/dokka/src/jsMain/kotlin/org/kotlintestmpp/JsFunctions.kt
@@ -0,0 +1,18 @@
+package org.kotlintestmpp
+
+/**
+ * Function declares in JS source set
+ */
+fun js() {}
+
+/**
+ * Function declared in JS source set.
+ *
+ * Function with the same name exists in another source set as well.
+ */
+fun shared() {}
+
+/**
+ * Extension declared in JS source set
+ */
+fun String.myExtension() = println("test")
diff --git a/dokka-runners/dokkatoo/examples/multiplatform-example/dokka/src/jvmMain/kotlin/org/kotlintestmpp/JavaAnnotation.java b/dokka-runners/dokkatoo/examples/multiplatform-example/dokka/src/jvmMain/kotlin/org/kotlintestmpp/JavaAnnotation.java
new file mode 100644
index 00000000..8b11ca09
--- /dev/null
+++ b/dokka-runners/dokkatoo/examples/multiplatform-example/dokka/src/jvmMain/kotlin/org/kotlintestmpp/JavaAnnotation.java
@@ -0,0 +1,19 @@
+package org.kotlintestmpp;
+
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+/**
+ * This is a Java annotation
+ */
+@Target(ElementType.TYPE)
+@Retention(RetentionPolicy.RUNTIME)
+public @interface JavaAnnotation {
+    String usage();
+
+    String[] aliases();
+
+    String description();
+}
diff --git a/dokka-runners/dokkatoo/examples/multiplatform-example/dokka/src/jvmMain/kotlin/org/kotlintestmpp/JvmCoroutineExtensions.kt b/dokka-runners/dokkatoo/examples/multiplatform-example/dokka/src/jvmMain/kotlin/org/kotlintestmpp/JvmCoroutineExtensions.kt
new file mode 100644
index 00000000..8f7fda49
--- /dev/null
+++ b/dokka-runners/dokkatoo/examples/multiplatform-example/dokka/src/jvmMain/kotlin/org/kotlintestmpp/JvmCoroutineExtensions.kt
@@ -0,0 +1,11 @@
+package org.kotlintestmpp.coroutines
+
+import kotlinx.coroutines.CoroutineScope
+import kotlinx.coroutines.Deferred
+
+/**
+ * JVM actual implementation for `asyncWithDelay`
+ */
+actual fun <T> CoroutineScope.asyncWithDealy(delay: Long, block: suspend () -> T): Deferred<T> {
+    TODO("Not yet implemented")
+}
diff --git a/dokka-runners/dokkatoo/examples/multiplatform-example/dokka/src/jvmMain/kotlin/org/kotlintestmpp/JvmDateUtils.kt b/dokka-runners/dokkatoo/examples/multiplatform-example/dokka/src/jvmMain/kotlin/org/kotlintestmpp/JvmDateUtils.kt
new file mode 100644
index 00000000..db7f2d74
--- /dev/null
+++ b/dokka-runners/dokkatoo/examples/multiplatform-example/dokka/src/jvmMain/kotlin/org/kotlintestmpp/JvmDateUtils.kt
@@ -0,0 +1,8 @@
+package org.kotlintestmpp.date
+
+/**
+ * JVM actual implementation for `getCurrentDate`
+ */
+actual fun getCurrentDate(): String {
+    return "test"
+}
diff --git a/dokka-runners/dokkatoo/examples/multiplatform-example/dokka/src/jvmMain/kotlin/org/kotlintestmpp/JvmFunctions.kt b/dokka-runners/dokkatoo/examples/multiplatform-example/dokka/src/jvmMain/kotlin/org/kotlintestmpp/JvmFunctions.kt
new file mode 100644
index 00000000..0ef8a99d
--- /dev/null
+++ b/dokka-runners/dokkatoo/examples/multiplatform-example/dokka/src/jvmMain/kotlin/org/kotlintestmpp/JvmFunctions.kt
@@ -0,0 +1,35 @@
+package org.kotlintestmpp
+
+import kotlinx.coroutines.CoroutineScope
+import kotlinx.coroutines.Job
+import kotlinx.coroutines.launch
+import org.kotlintestmpp.common.Foo
+
+/**
+ * Function declared in JVM source set
+ *
+ * also see the [Foo] class
+ * @see org.kotlintestmpp.common.Foo
+ */
+fun jvm() {}
+
+/**
+ * Function declared in JVM source set
+ *
+ * Function with the same name exists in another source set as well.
+ */
+fun shared() {}
+
+/**
+ * Extension declared in JVM source set
+ */
+fun CoroutineScope.startConnectionPipeline(
+    input: String
+): Job = launch { TODO() }
+
+/**
+ * Extension declared in JVM source set
+ */
+fun String.myExtension() = println("test2")
+
+
diff --git a/dokka-runners/dokkatoo/examples/multiplatform-example/dokka/src/linuxMain/kotlin/org/kotlintestmpp/CInterop.kt b/dokka-runners/dokkatoo/examples/multiplatform-example/dokka/src/linuxMain/kotlin/org/kotlintestmpp/CInterop.kt
new file mode 100644
index 00000000..5c84780b
--- /dev/null
+++ b/dokka-runners/dokkatoo/examples/multiplatform-example/dokka/src/linuxMain/kotlin/org/kotlintestmpp/CInterop.kt
@@ -0,0 +1,15 @@
+@file:Suppress("unused")
+
+package org.kotlintestmpp
+
+import kotlinx.cinterop.CPointed
+import kotlinx.cinterop.CPointer
+import kotlinx.cinterop.ExperimentalForeignApi
+
+/**
+ * Low-level Linux function
+ */
+@OptIn(ExperimentalForeignApi::class)
+fun <T : CPointed> printPointerRawValue(pointer: CPointer<T>) {
+    println(pointer.rawValue)
+}
diff --git a/dokka-runners/dokkatoo/examples/multiplatform-example/dokka/src/linuxMain/kotlin/org/kotlintestmpp/LinuxCoroutineExtensions.kt b/dokka-runners/dokkatoo/examples/multiplatform-example/dokka/src/linuxMain/kotlin/org/kotlintestmpp/LinuxCoroutineExtensions.kt
new file mode 100644
index 00000000..b561272d
--- /dev/null
+++ b/dokka-runners/dokkatoo/examples/multiplatform-example/dokka/src/linuxMain/kotlin/org/kotlintestmpp/LinuxCoroutineExtensions.kt
@@ -0,0 +1,11 @@
+package org.kotlintestmpp.coroutines
+
+import kotlinx.coroutines.CoroutineScope
+import kotlinx.coroutines.Deferred
+
+/**
+ * Linux actual implementation for `asyncWithDelay`
+ */
+actual fun <T> CoroutineScope.asyncWithDealy(delay: Long, block: suspend () -> T): Deferred<T> {
+    TODO("Not yet implemented")
+}
diff --git a/dokka-runners/dokkatoo/examples/multiplatform-example/dokka/src/linuxMain/kotlin/org/kotlintestmpp/LinuxDateUtils.kt b/dokka-runners/dokkatoo/examples/multiplatform-example/dokka/src/linuxMain/kotlin/org/kotlintestmpp/LinuxDateUtils.kt
new file mode 100644
index 00000000..8900f87b
--- /dev/null
+++ b/dokka-runners/dokkatoo/examples/multiplatform-example/dokka/src/linuxMain/kotlin/org/kotlintestmpp/LinuxDateUtils.kt
@@ -0,0 +1,8 @@
+package org.kotlintestmpp.date
+
+/**
+ * Linux actual implementation for `getCurrentDate`
+ */
+actual fun getCurrentDate(): String {
+    TODO("Not yet implemented")
+}
diff --git a/dokka-runners/dokkatoo/examples/multiplatform-example/dokka/src/macosMain/kotlin/org/kotlintestmpp/MacOsCoroutineExtensions.kt b/dokka-runners/dokkatoo/examples/multiplatform-example/dokka/src/macosMain/kotlin/org/kotlintestmpp/MacOsCoroutineExtensions.kt
new file mode 100644
index 00000000..8576982c
--- /dev/null
+++ b/dokka-runners/dokkatoo/examples/multiplatform-example/dokka/src/macosMain/kotlin/org/kotlintestmpp/MacOsCoroutineExtensions.kt
@@ -0,0 +1,11 @@
+package org.kotlintestmpp.coroutines
+
+import kotlinx.coroutines.CoroutineScope
+import kotlinx.coroutines.Deferred
+
+/**
+ * MacOS actual implementation for `asyncWithDelay`
+ */
+actual fun <T> CoroutineScope.asyncWithDealy(delay: Long, block: suspend () -> T): Deferred<T> {
+    TODO("Not yet implemented")
+}
diff --git a/dokka-runners/dokkatoo/examples/multiplatform-example/dokka/src/macosMain/kotlin/org/kotlintestmpp/MacOsDateUtils.kt b/dokka-runners/dokkatoo/examples/multiplatform-example/dokka/src/macosMain/kotlin/org/kotlintestmpp/MacOsDateUtils.kt
new file mode 100644
index 00000000..accf98a9
--- /dev/null
+++ b/dokka-runners/dokkatoo/examples/multiplatform-example/dokka/src/macosMain/kotlin/org/kotlintestmpp/MacOsDateUtils.kt
@@ -0,0 +1,8 @@
+package org.kotlintestmpp.date
+
+/**
+ * MacOS actual implementation for `getCurrentDate`
+ */
+actual fun getCurrentDate(): String {
+    TODO("Not yet implemented")
+}
diff --git a/dokka-runners/dokkatoo/examples/multiplatform-example/dokkatoo/build.gradle.kts b/dokka-runners/dokkatoo/examples/multiplatform-example/dokkatoo/build.gradle.kts
new file mode 100644
index 00000000..3d5a9e0d
--- /dev/null
+++ b/dokka-runners/dokkatoo/examples/multiplatform-example/dokkatoo/build.gradle.kts
@@ -0,0 +1,39 @@
+plugins {
+  kotlin("multiplatform") version "1.9.0"
+  id("org.jetbrains.dokka.dokkatoo") version "2.1.0-SNAPSHOT"
+}
+
+group = "org.dokka.example"
+version = "1.0-SNAPSHOT"
+
+kotlin {
+  jvm() // Creates a JVM target with the default name "jvm"
+  linuxX64("linux")
+  macosX64("macos")
+  js(IR) {
+    browser()
+  }
+  sourceSets {
+    commonMain {
+      dependencies {
+        implementation("org.jetbrains.kotlinx:kotlinx-coroutines-core:1.5.1")
+      }
+    }
+  }
+}
+
+dokkatoo {
+  // Create a custom source set not known to the Kotlin Gradle Plugin
+  dokkatooSourceSets.register("customSourceSet") {
+    jdkVersion.set(9)
+    displayName.set("custom")
+    sourceRoots.from("src/customJdk9/kotlin")
+  }
+}
+
+
+//region DON'T COPY - this is only needed for internal Dokkatoo integration tests
+dokkatoo {
+  sourceSetScopeDefault.set(":dokkaHtml")
+}
+//endregion
diff --git a/dokka-runners/dokkatoo/examples/multiplatform-example/dokkatoo/settings.gradle.kts b/dokka-runners/dokkatoo/examples/multiplatform-example/dokkatoo/settings.gradle.kts
new file mode 100644
index 00000000..014a7584
--- /dev/null
+++ b/dokka-runners/dokkatoo/examples/multiplatform-example/dokkatoo/settings.gradle.kts
@@ -0,0 +1,17 @@
+rootProject.name = "dokka-multiplatform-example"
+
+pluginManagement {
+  repositories {
+    gradlePluginPortal()
+    mavenCentral()
+    maven(providers.gradleProperty("testMavenRepo"))
+  }
+}
+
+@Suppress("UnstableApiUsage")
+dependencyResolutionManagement {
+  repositories {
+    mavenCentral()
+    maven(providers.gradleProperty("testMavenRepo"))
+  }
+}
diff --git a/dokka-runners/dokkatoo/examples/multiplatform-example/dokkatoo/src/commonMain/kotlin/org/kotlintestmpp/CommonCoroutineExtensions.kt b/dokka-runners/dokkatoo/examples/multiplatform-example/dokkatoo/src/commonMain/kotlin/org/kotlintestmpp/CommonCoroutineExtensions.kt
new file mode 100644
index 00000000..30bea657
--- /dev/null
+++ b/dokka-runners/dokkatoo/examples/multiplatform-example/dokkatoo/src/commonMain/kotlin/org/kotlintestmpp/CommonCoroutineExtensions.kt
@@ -0,0 +1,15 @@
+package org.kotlintestmpp.coroutines
+
+import kotlinx.coroutines.CoroutineScope
+import kotlinx.coroutines.CoroutineDispatcher
+import kotlinx.coroutines.Deferred
+
+/**
+ * Common `expect` declaration
+ */
+expect fun <T> CoroutineScope.asyncWithDealy(delay: Long, block: suspend () -> T): Deferred<T>
+
+/**
+ * Common coroutine extension
+ */
+fun CoroutineDispatcher.name(): String = TODO("Not implemented")
diff --git a/dokka-runners/dokkatoo/examples/multiplatform-example/dokkatoo/src/commonMain/kotlin/org/kotlintestmpp/CommonDateUtils.kt b/dokka-runners/dokkatoo/examples/multiplatform-example/dokkatoo/src/commonMain/kotlin/org/kotlintestmpp/CommonDateUtils.kt
new file mode 100644
index 00000000..b241f5ea
--- /dev/null
+++ b/dokka-runners/dokkatoo/examples/multiplatform-example/dokkatoo/src/commonMain/kotlin/org/kotlintestmpp/CommonDateUtils.kt
@@ -0,0 +1,14 @@
+package org.kotlintestmpp.date
+
+/**
+ * Common `expect` declaration
+ */
+expect fun getCurrentDate(): String
+
+/**
+ * Common date util function
+ */
+fun getDate(): String {
+    return "Today's Date is ${getCurrentDate()}"
+}
+
diff --git a/dokka-runners/dokkatoo/examples/multiplatform-example/dokkatoo/src/commonMain/kotlin/org/kotlintestmpp/common/Foo.kt b/dokka-runners/dokkatoo/examples/multiplatform-example/dokkatoo/src/commonMain/kotlin/org/kotlintestmpp/common/Foo.kt
new file mode 100644
index 00000000..96c825c5
--- /dev/null
+++ b/dokka-runners/dokkatoo/examples/multiplatform-example/dokkatoo/src/commonMain/kotlin/org/kotlintestmpp/common/Foo.kt
@@ -0,0 +1,7 @@
+package org.kotlintestmpp.common
+
+/**
+ * Common Foo class
+ */
+class Foo {}
+
diff --git a/dokka-runners/dokkatoo/examples/multiplatform-example/dokkatoo/src/customJdk9/kotlin/org/kotlintest/jdk9/CustomSourceSetFile.kt b/dokka-runners/dokkatoo/examples/multiplatform-example/dokkatoo/src/customJdk9/kotlin/org/kotlintest/jdk9/CustomSourceSetFile.kt
new file mode 100644
index 00000000..d77b959b
--- /dev/null
+++ b/dokka-runners/dokkatoo/examples/multiplatform-example/dokkatoo/src/customJdk9/kotlin/org/kotlintest/jdk9/CustomSourceSetFile.kt
@@ -0,0 +1,11 @@
+package org.kotlintest.jdk9
+
+/**
+ * This class demonstrates custom dokka source sets
+ */
+class CustomSourceSetFile {
+    /**
+     * This function will not do anything
+     */
+    fun thisIsAFunction() {}
+}
diff --git a/dokka-runners/dokkatoo/examples/multiplatform-example/dokkatoo/src/jsMain/kotlin/org/kotlintestmpp/JsCoroutineExtensions.kt b/dokka-runners/dokkatoo/examples/multiplatform-example/dokkatoo/src/jsMain/kotlin/org/kotlintestmpp/JsCoroutineExtensions.kt
new file mode 100644
index 00000000..85d6beb0
--- /dev/null
+++ b/dokka-runners/dokkatoo/examples/multiplatform-example/dokkatoo/src/jsMain/kotlin/org/kotlintestmpp/JsCoroutineExtensions.kt
@@ -0,0 +1,11 @@
+package org.kotlintestmpp.coroutines
+
+import kotlinx.coroutines.CoroutineScope
+import kotlinx.coroutines.Deferred
+
+/**
+ * JS actual implementation for `asyncWithDelay`
+ */
+actual fun <T> CoroutineScope.asyncWithDealy(delay: Long, block: suspend () -> T): Deferred<T> {
+    TODO("Not yet implemented")
+}
diff --git a/dokka-runners/dokkatoo/examples/multiplatform-example/dokkatoo/src/jsMain/kotlin/org/kotlintestmpp/JsDateUtils.kt b/dokka-runners/dokkatoo/examples/multiplatform-example/dokkatoo/src/jsMain/kotlin/org/kotlintestmpp/JsDateUtils.kt
new file mode 100644
index 00000000..2f4f3c45
--- /dev/null
+++ b/dokka-runners/dokkatoo/examples/multiplatform-example/dokkatoo/src/jsMain/kotlin/org/kotlintestmpp/JsDateUtils.kt
@@ -0,0 +1,8 @@
+package org.kotlintestmpp.date
+
+/**
+ * JS actual implementation for `getCurrentDate`
+ */
+actual fun getCurrentDate(): String {
+    return "test"
+}
diff --git a/dokka-runners/dokkatoo/examples/multiplatform-example/dokkatoo/src/jsMain/kotlin/org/kotlintestmpp/JsFunctions.kt b/dokka-runners/dokkatoo/examples/multiplatform-example/dokkatoo/src/jsMain/kotlin/org/kotlintestmpp/JsFunctions.kt
new file mode 100644
index 00000000..76757359
--- /dev/null
+++ b/dokka-runners/dokkatoo/examples/multiplatform-example/dokkatoo/src/jsMain/kotlin/org/kotlintestmpp/JsFunctions.kt
@@ -0,0 +1,18 @@
+package org.kotlintestmpp
+
+/**
+ * Function declares in JS source set
+ */
+fun js() {}
+
+/**
+ * Function declared in JS source set.
+ *
+ * Function with the same name exists in another source set as well.
+ */
+fun shared() {}
+
+/**
+ * Extension declared in JS source set
+ */
+fun String.myExtension() = println("test")
diff --git a/dokka-runners/dokkatoo/examples/multiplatform-example/dokkatoo/src/jvmMain/kotlin/org/kotlintestmpp/JavaAnnotation.java b/dokka-runners/dokkatoo/examples/multiplatform-example/dokkatoo/src/jvmMain/kotlin/org/kotlintestmpp/JavaAnnotation.java
new file mode 100644
index 00000000..8b11ca09
--- /dev/null
+++ b/dokka-runners/dokkatoo/examples/multiplatform-example/dokkatoo/src/jvmMain/kotlin/org/kotlintestmpp/JavaAnnotation.java
@@ -0,0 +1,19 @@
+package org.kotlintestmpp;
+
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+/**
+ * This is a Java annotation
+ */
+@Target(ElementType.TYPE)
+@Retention(RetentionPolicy.RUNTIME)
+public @interface JavaAnnotation {
+    String usage();
+
+    String[] aliases();
+
+    String description();
+}
diff --git a/dokka-runners/dokkatoo/examples/multiplatform-example/dokkatoo/src/jvmMain/kotlin/org/kotlintestmpp/JvmCoroutineExtensions.kt b/dokka-runners/dokkatoo/examples/multiplatform-example/dokkatoo/src/jvmMain/kotlin/org/kotlintestmpp/JvmCoroutineExtensions.kt
new file mode 100644
index 00000000..8f7fda49
--- /dev/null
+++ b/dokka-runners/dokkatoo/examples/multiplatform-example/dokkatoo/src/jvmMain/kotlin/org/kotlintestmpp/JvmCoroutineExtensions.kt
@@ -0,0 +1,11 @@
+package org.kotlintestmpp.coroutines
+
+import kotlinx.coroutines.CoroutineScope
+import kotlinx.coroutines.Deferred
+
+/**
+ * JVM actual implementation for `asyncWithDelay`
+ */
+actual fun <T> CoroutineScope.asyncWithDealy(delay: Long, block: suspend () -> T): Deferred<T> {
+    TODO("Not yet implemented")
+}
diff --git a/dokka-runners/dokkatoo/examples/multiplatform-example/dokkatoo/src/jvmMain/kotlin/org/kotlintestmpp/JvmDateUtils.kt b/dokka-runners/dokkatoo/examples/multiplatform-example/dokkatoo/src/jvmMain/kotlin/org/kotlintestmpp/JvmDateUtils.kt
new file mode 100644
index 00000000..db7f2d74
--- /dev/null
+++ b/dokka-runners/dokkatoo/examples/multiplatform-example/dokkatoo/src/jvmMain/kotlin/org/kotlintestmpp/JvmDateUtils.kt
@@ -0,0 +1,8 @@
+package org.kotlintestmpp.date
+
+/**
+ * JVM actual implementation for `getCurrentDate`
+ */
+actual fun getCurrentDate(): String {
+    return "test"
+}
diff --git a/dokka-runners/dokkatoo/examples/multiplatform-example/dokkatoo/src/jvmMain/kotlin/org/kotlintestmpp/JvmFunctions.kt b/dokka-runners/dokkatoo/examples/multiplatform-example/dokkatoo/src/jvmMain/kotlin/org/kotlintestmpp/JvmFunctions.kt
new file mode 100644
index 00000000..0ef8a99d
--- /dev/null
+++ b/dokka-runners/dokkatoo/examples/multiplatform-example/dokkatoo/src/jvmMain/kotlin/org/kotlintestmpp/JvmFunctions.kt
@@ -0,0 +1,35 @@
+package org.kotlintestmpp
+
+import kotlinx.coroutines.CoroutineScope
+import kotlinx.coroutines.Job
+import kotlinx.coroutines.launch
+import org.kotlintestmpp.common.Foo
+
+/**
+ * Function declared in JVM source set
+ *
+ * also see the [Foo] class
+ * @see org.kotlintestmpp.common.Foo
+ */
+fun jvm() {}
+
+/**
+ * Function declared in JVM source set
+ *
+ * Function with the same name exists in another source set as well.
+ */
+fun shared() {}
+
+/**
+ * Extension declared in JVM source set
+ */
+fun CoroutineScope.startConnectionPipeline(
+    input: String
+): Job = launch { TODO() }
+
+/**
+ * Extension declared in JVM source set
+ */
+fun String.myExtension() = println("test2")
+
+
diff --git a/dokka-runners/dokkatoo/examples/multiplatform-example/dokkatoo/src/linuxMain/kotlin/org/kotlintestmpp/CInterop.kt b/dokka-runners/dokkatoo/examples/multiplatform-example/dokkatoo/src/linuxMain/kotlin/org/kotlintestmpp/CInterop.kt
new file mode 100644
index 00000000..5c84780b
--- /dev/null
+++ b/dokka-runners/dokkatoo/examples/multiplatform-example/dokkatoo/src/linuxMain/kotlin/org/kotlintestmpp/CInterop.kt
@@ -0,0 +1,15 @@
+@file:Suppress("unused")
+
+package org.kotlintestmpp
+
+import kotlinx.cinterop.CPointed
+import kotlinx.cinterop.CPointer
+import kotlinx.cinterop.ExperimentalForeignApi
+
+/**
+ * Low-level Linux function
+ */
+@OptIn(ExperimentalForeignApi::class)
+fun <T : CPointed> printPointerRawValue(pointer: CPointer<T>) {
+    println(pointer.rawValue)
+}
diff --git a/dokka-runners/dokkatoo/examples/multiplatform-example/dokkatoo/src/linuxMain/kotlin/org/kotlintestmpp/LinuxCoroutineExtensions.kt b/dokka-runners/dokkatoo/examples/multiplatform-example/dokkatoo/src/linuxMain/kotlin/org/kotlintestmpp/LinuxCoroutineExtensions.kt
new file mode 100644
index 00000000..b561272d
--- /dev/null
+++ b/dokka-runners/dokkatoo/examples/multiplatform-example/dokkatoo/src/linuxMain/kotlin/org/kotlintestmpp/LinuxCoroutineExtensions.kt
@@ -0,0 +1,11 @@
+package org.kotlintestmpp.coroutines
+
+import kotlinx.coroutines.CoroutineScope
+import kotlinx.coroutines.Deferred
+
+/**
+ * Linux actual implementation for `asyncWithDelay`
+ */
+actual fun <T> CoroutineScope.asyncWithDealy(delay: Long, block: suspend () -> T): Deferred<T> {
+    TODO("Not yet implemented")
+}
diff --git a/dokka-runners/dokkatoo/examples/multiplatform-example/dokkatoo/src/linuxMain/kotlin/org/kotlintestmpp/LinuxDateUtils.kt b/dokka-runners/dokkatoo/examples/multiplatform-example/dokkatoo/src/linuxMain/kotlin/org/kotlintestmpp/LinuxDateUtils.kt
new file mode 100644
index 00000000..8900f87b
--- /dev/null
+++ b/dokka-runners/dokkatoo/examples/multiplatform-example/dokkatoo/src/linuxMain/kotlin/org/kotlintestmpp/LinuxDateUtils.kt
@@ -0,0 +1,8 @@
+package org.kotlintestmpp.date
+
+/**
+ * Linux actual implementation for `getCurrentDate`
+ */
+actual fun getCurrentDate(): String {
+    TODO("Not yet implemented")
+}
diff --git a/dokka-runners/dokkatoo/examples/multiplatform-example/dokkatoo/src/macosMain/kotlin/org/kotlintestmpp/MacOsCoroutineExtensions.kt b/dokka-runners/dokkatoo/examples/multiplatform-example/dokkatoo/src/macosMain/kotlin/org/kotlintestmpp/MacOsCoroutineExtensions.kt
new file mode 100644
index 00000000..8576982c
--- /dev/null
+++ b/dokka-runners/dokkatoo/examples/multiplatform-example/dokkatoo/src/macosMain/kotlin/org/kotlintestmpp/MacOsCoroutineExtensions.kt
@@ -0,0 +1,11 @@
+package org.kotlintestmpp.coroutines
+
+import kotlinx.coroutines.CoroutineScope
+import kotlinx.coroutines.Deferred
+
+/**
+ * MacOS actual implementation for `asyncWithDelay`
+ */
+actual fun <T> CoroutineScope.asyncWithDealy(delay: Long, block: suspend () -> T): Deferred<T> {
+    TODO("Not yet implemented")
+}
diff --git a/dokka-runners/dokkatoo/examples/multiplatform-example/dokkatoo/src/macosMain/kotlin/org/kotlintestmpp/MacOsDateUtils.kt b/dokka-runners/dokkatoo/examples/multiplatform-example/dokkatoo/src/macosMain/kotlin/org/kotlintestmpp/MacOsDateUtils.kt
new file mode 100644
index 00000000..accf98a9
--- /dev/null
+++ b/dokka-runners/dokkatoo/examples/multiplatform-example/dokkatoo/src/macosMain/kotlin/org/kotlintestmpp/MacOsDateUtils.kt
@@ -0,0 +1,8 @@
+package org.kotlintestmpp.date
+
+/**
+ * MacOS actual implementation for `getCurrentDate`
+ */
+actual fun getCurrentDate(): String {
+    TODO("Not yet implemented")
+}