Refactoring for kdoc API documentation with dokka

1 files changed, 19 insertions, 2 deletions

diff --git a/src/main/kotlin/pl/treksoft/kvision/ApplicationBase.kt b/src/main/kotlin/pl/treksoft/kvision/ApplicationBase.kt
index e9e99fc7..83ad69ca 100644
--- a/src/main/kotlin/pl/treksoft/kvision/ApplicationBase.kt
+++ b/src/main/kotlin/pl/treksoft/kvision/ApplicationBase.kt
@@ -1,6 +1,23 @@
+/**
+ * @author Robert Jaros
+ */
 package pl.treksoft.kvision
 
+/**
+ * Base class for applications.
+ *
+ * Every application class should inherit from this abstract class.
+*/
 abstract class ApplicationBase {
-    abstract fun start(state: Map<String, Any>)
-    abstract fun dispose(): Map<String, Any>
+/**
+ * Starting point for an application.
+ * @param state Initial state between Hot Module Replacement (HMR).
+*/
+abstract fun start(state: Map<String, Any>)
+
+/**
+ * Ending point for an application.
+ * @return final state for Hot Module Replacement (HMR).
+*/
+abstract fun dispose(): Map<String, Any>
 }