release: v0.0.1

Author: arduia

mvvm/src/main/java/com/arduia/mvvm/Event.kt

@@ -19,7 +19,9 @@ package com.arduia.mvvm
 
 import androidx.lifecycle.Observer
 
-
+/**
+ * Event State with data that can be consumed once.
+ */
 open class Event<out T> (private val content: T){
 
     var hasHandled = false
@@ -37,7 +39,9 @@ open class Event<out T> (private val content: T){
     fun peekContent(): T = content
 }
 
-
+/**
+ * Observer that consume {@link Event} Data
+ */
 class EventObserver<T> (private val onEventUnhandledContent: (T)-> Unit): Observer<Event<T>>{
 
     override fun onChanged(event: Event<T>?) {
@@ -47,6 +51,10 @@ class EventObserver<T> (private val onEventUnhandledContent: (T)-> Unit): Observ
     }
 }
 
+/**
+ * For State Event that represent state with no data.
+ */
 val EventUnit get() =  Event(Unit)
 
+
 fun <T>event(content: T) = Event(content)

mvvm/src/main/java/com/arduia/mvvm/LiveData.kt

@@ -20,6 +20,14 @@ package com.arduia.mvvm
 import androidx.lifecycle.LiveData
 import androidx.lifecycle.MutableLiveData
 
+/**
+ * Base MutableLiveData that has LiveData casting with
+ * fun asLiveData() to use for encapsulations such as:
+ *
+ * Example -
+ * private val _data = BaseLiveData<String>();
+ * val data = _data.asLiveData()
+ */
 
 class BaseLiveData<T> : MutableLiveData<T>(){
     fun asLiveData(): LiveData<T> = this