Refactoring for kdoc API documentation with dokka

1 files changed, 15 insertions, 0 deletions

diff --git a/src/main/kotlin/pl/treksoft/kvision/HMR.kt b/src/main/kotlin/pl/treksoft/kvision/HMR.kt
index e657567a..6fb9dfed 100644
--- a/src/main/kotlin/pl/treksoft/kvision/HMR.kt
+++ b/src/main/kotlin/pl/treksoft/kvision/HMR.kt
@@ -1,11 +1,23 @@
+/**
+ * @author Robert Jaros
+ */
 package pl.treksoft.kvision
 
+/**
+ * Helper variable for Hot Module Replacement (HMR).
+ */
 external val module: Module
 
+/**
+ * Helper interface for Hot Module Replacement (HMR).
+ */
 external interface Module {
     val hot: Hot?
 }
 
+/**
+ * Helper interface for Hot Module Replacement (HMR).
+ */
 external interface Hot {
     val data: dynamic
 
@@ -16,4 +28,7 @@ external interface Hot {
     fun dispose(callback: (data: dynamic) -> Unit)
 }
 
+/**
+ * External function for loading CommonJS modules.
+ */
 external fun require(name: String): dynamic