Revise README documentation for examples and plugins (#2736)

5 files changed, 30 insertions, 29 deletions

diff --git a/examples/gradle/dokka-multiplatform-example/src/jsMain/kotlin/org/kotlintestmpp/asyncWithDealy.kt b/examples/gradle/dokka-multiplatform-example/src/jsMain/kotlin/org/kotlintestmpp/JsCoroutineExtensions.kt
index 7b5fe652..85d6beb0 100644
--- a/examples/gradle/dokka-multiplatform-example/src/jsMain/kotlin/org/kotlintestmpp/asyncWithDealy.kt
+++ b/examples/gradle/dokka-multiplatform-example/src/jsMain/kotlin/org/kotlintestmpp/JsCoroutineExtensions.kt
@@ -1,8 +1,11 @@
-package org.kotlintestmpp
+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/examples/gradle/dokka-multiplatform-example/src/jsMain/kotlin/org/kotlintestmpp/JsDateUtils.kt b/examples/gradle/dokka-multiplatform-example/src/jsMain/kotlin/org/kotlintestmpp/JsDateUtils.kt
new file mode 100644
index 00000000..2f4f3c45
--- /dev/null
+++ b/examples/gradle/dokka-multiplatform-example/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/examples/gradle/dokka-multiplatform-example/src/jsMain/kotlin/org/kotlintestmpp/JsFunctions.kt b/examples/gradle/dokka-multiplatform-example/src/jsMain/kotlin/org/kotlintestmpp/JsFunctions.kt
new file mode 100644
index 00000000..76757359
--- /dev/null
+++ b/examples/gradle/dokka-multiplatform-example/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/examples/gradle/dokka-multiplatform-example/src/jsMain/kotlin/org/kotlintestmpp/main.kt b/examples/gradle/dokka-multiplatform-example/src/jsMain/kotlin/org/kotlintestmpp/main.kt
deleted file mode 100644
index 8cb66e6d..00000000
--- a/examples/gradle/dokka-multiplatform-example/src/jsMain/kotlin/org/kotlintestmpp/main.kt
+++ /dev/null
@@ -1,17 +0,0 @@
-package org.kotlintestmpp
-
-fun main(args : Array<String>) {
-    console.log("Hello, world!")
-}
-
-fun js(){}
-fun shared(){}
-
-/**
- * Actual function for js
- */
-actual fun getCurrentDate(): String {
-    return "test"
-}
-
-fun String.myExtension() = println("test")
\ No newline at end of file
diff --git a/examples/gradle/dokka-multiplatform-example/src/jsMain/kotlin/shouldbesuppressed/supp.kt b/examples/gradle/dokka-multiplatform-example/src/jsMain/kotlin/shouldbesuppressed/supp.kt
deleted file mode 100644
index 21dca566..00000000
--- a/examples/gradle/dokka-multiplatform-example/src/jsMain/kotlin/shouldbesuppressed/supp.kt
+++ /dev/null
@@ -1,11 +0,0 @@
-package shouldbesuppressed
-
-/**
- * This function should not be visible
- */
-fun thatShouldNotBeVisible(): String = "oops"
-
-/**
- * This class should not be visible
- */
-class DontLookAtMe(val stealth: Int = 9001)
\ No newline at end of file