Revise README documentation for examples and plugins (#2736)

4 files changed, 16 insertions, 10 deletions

diff --git a/examples/gradle/dokka-multiplatform-example/src/linuxMain/kotlin/org/kotlintestmpp/cinterop.kt b/examples/gradle/dokka-multiplatform-example/src/linuxMain/kotlin/org/kotlintestmpp/CInterop.kt
index efc60f23..c42cfea1 100644
--- a/examples/gradle/dokka-multiplatform-example/src/linuxMain/kotlin/org/kotlintestmpp/cinterop.kt
+++ b/examples/gradle/dokka-multiplatform-example/src/linuxMain/kotlin/org/kotlintestmpp/CInterop.kt
@@ -5,6 +5,9 @@ package org.kotlintestmpp
 import kotlinx.cinterop.CPointed
 import kotlinx.cinterop.CPointer
 
-fun<T: CPointed> printPointerRawValue(pointer: CPointer<T>) {
+/**
+ * Low-level Linux function
+ */
+fun <T : CPointed> printPointerRawValue(pointer: CPointer<T>) {
     println(pointer.rawValue)
 }
diff --git a/examples/gradle/dokka-multiplatform-example/src/linuxMain/kotlin/org/kotlintestmpp/asyncWithDealy.kt b/examples/gradle/dokka-multiplatform-example/src/linuxMain/kotlin/org/kotlintestmpp/LinuxCoroutineExtensions.kt
index 7b5fe652..b561272d 100644
--- a/examples/gradle/dokka-multiplatform-example/src/linuxMain/kotlin/org/kotlintestmpp/asyncWithDealy.kt
+++ b/examples/gradle/dokka-multiplatform-example/src/linuxMain/kotlin/org/kotlintestmpp/LinuxCoroutineExtensions.kt
@@ -1,8 +1,11 @@
-package org.kotlintestmpp
+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/examples/gradle/dokka-multiplatform-example/src/linuxMain/kotlin/org/kotlintestmpp/LinuxDateUtils.kt b/examples/gradle/dokka-multiplatform-example/src/linuxMain/kotlin/org/kotlintestmpp/LinuxDateUtils.kt
new file mode 100644
index 00000000..8900f87b
--- /dev/null
+++ b/examples/gradle/dokka-multiplatform-example/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/examples/gradle/dokka-multiplatform-example/src/linuxMain/kotlin/org/kotlintestmpp/getCurrentDate.kt b/examples/gradle/dokka-multiplatform-example/src/linuxMain/kotlin/org/kotlintestmpp/getCurrentDate.kt
deleted file mode 100644
index 86f27c15..00000000
--- a/examples/gradle/dokka-multiplatform-example/src/linuxMain/kotlin/org/kotlintestmpp/getCurrentDate.kt
+++ /dev/null
@@ -1,8 +0,0 @@
-package org.kotlintestmpp
-
-/**
- * Actual function for linux
- */
-actual fun getCurrentDate(): String {
-    TODO("Not yet implemented")
-}
\ No newline at end of file