feat:Add documentation

Author: KevinnZou

lifecycletracker/src/androidMain/kotlin/com/multiplatform/lifecyle/AndroidLifecycleEventObserver.kt

@@ -6,9 +6,10 @@ import com.multiplatform.lifecycle.LifecycleEvent
 import com.multiplatform.lifecycle.LifecycleTracker
 
 /**
- * Created By Kevin Zou On 2024/2/22
+ * An observer for Android lifecycle events.
  */
-class AndroidLifecycleEventObserver(private val lifecycleTracker: LifecycleTracker) : DefaultLifecycleObserver {
+class AndroidLifecycleEventObserver(private val lifecycleTracker: LifecycleTracker) :
+    DefaultLifecycleObserver {
     override fun onCreate(owner: LifecycleOwner) {
         super.onCreate(owner)
         lifecycleTracker.handleLifecycleEvent(LifecycleEvent.OnCreateEvent)

lifecycletracker/src/commonMain/kotlin/com.multiplatform.lifecycle/Lifecycle.kt

@@ -1,7 +1,7 @@
 package com.multiplatform.lifecycle
 
 /**
- * Created By Kevin Zou On 2024/2/26
+ * A class that has an Android-like lifecycle.
  */
 abstract class Lifecycle {
     /**
@@ -14,28 +14,18 @@ abstract class Lifecycle {
      *
      * @param observer The observer to notify.
      */
-     abstract fun addObserver(observer: LifecycleObserver)
+    abstract fun addObserver(observer: LifecycleObserver)
 
     /**
      * Removes the given observer from the observers list.
-     *
-     * If this method is called while a state change is being dispatched,
-     *
-     *  * If the given observer has not yet received that event, it will not receive it.
-     *  * If the given observer has more than 1 method that observes the currently dispatched
-     * event and at least one of them received the event, all of them will receive the event and
-     * the removal will happen afterwards.
-     *
-     *
      * @param observer The observer to be removed.
      */
-     abstract fun removeObserver(observer: LifecycleObserver)
+    abstract fun removeObserver(observer: LifecycleObserver)
 
     /**
      * Returns the current state of the Lifecycle.
      *
      * @return The current state of the Lifecycle.
      */
-     abstract val currentState: State
-
-}
+    abstract val currentState: State
+}

lifecycletracker/src/commonMain/kotlin/com.multiplatform.lifecycle/LifecycleEvent.kt

@@ -1,7 +1,7 @@
 package com.multiplatform.lifecycle
 
 /**
- * Created By Kevin Zou On 2024/2/22
+ * Lifecycle events. These events can be used by developers to listen to the lifecycle of the application.
  */
 sealed class LifecycleEvent {
     data object OnCreateEvent : LifecycleEvent()

lifecycletracker/src/commonMain/kotlin/com.multiplatform.lifecycle/LifecycleObserver.kt

@@ -1,7 +1,7 @@
 package com.multiplatform.lifecycle
 
 /**
- * Created By Kevin Zou On 2024/2/22
+ * A lifecycle tracker that can be used to track the lifecycle of a component.
  */
 interface LifecycleObserver {
     fun onEvent(event: LifecycleEvent) {

lifecycletracker/src/commonMain/kotlin/com.multiplatform.lifecycle/LifecycleState.kt

@@ -1,9 +1,5 @@
 package com.multiplatform.lifecycle
 
-/**
- * Created By Kevin Zou On 2024/2/26
- */
-
 /**
  * Lifecycle states. You can consider the states as the nodes in a graph and
  * [LifecycleEvent]s as the edges between these nodes.
@@ -59,7 +55,9 @@ enum class State {
      * Resumed state for a LifecycleOwner. For an [android.app.Activity], this state
      * is reached after [onResume][android.app.Activity.onResume] is called.
      */
-    RESUMED;
+    RESUMED,
+
+    ;
 
     /**
      * Compares if this State is greater or equal to the given `state`.
@@ -70,4 +68,4 @@ enum class State {
     fun isAtLeast(state: State): Boolean {
         return compareTo(state) >= 0
     }
-}
+}

lifecycletracker/src/commonMain/kotlin/com.multiplatform.lifecycle/LifecycleTracker.kt

@@ -1,9 +1,9 @@
 package com.multiplatform.lifecycle
 
 /**
- * Created By Kevin Zou On 2024/2/22
+ * A lifecycle tracker that can be used to track the lifecycle of the application.
  */
-open class LifecycleTracker: Lifecycle() {
+open class LifecycleTracker : Lifecycle() {
     /**
      * Current state
      */
@@ -34,11 +34,7 @@ open class LifecycleTracker: Lifecycle() {
 
     override var currentState: State
         get() = state
-        /**
-         * Moves the Lifecycle to the given state and dispatches necessary events to the observers.
-         *
-         * @param state new state
-         */
+
         set(state) {
             moveToState(state)
         }

lifecycletracker/src/commonMain/kotlin/com.multiplatform.lifecycle/LifecyleCompositionLocals.kt

@@ -2,16 +2,14 @@ package com.multiplatform.lifecycle
 
 import androidx.compose.runtime.staticCompositionLocalOf
 
-/**
- * Created By Kevin Zou On 2024/2/27
- */
 /**
  * The CompositionLocal containing the current [LifecycleTracker].
  */
-val LocalLifecycleTracker = staticCompositionLocalOf<LifecycleTracker> {
-    noLocalProvidedFor("LocalLifecycleTracker")
-}
+val LocalLifecycleTracker =
+    staticCompositionLocalOf<LifecycleTracker> {
+        noLocalProvidedFor("LocalLifecycleTracker")
+    }
 
 private fun noLocalProvidedFor(name: String): Nothing {
     error("CompositionLocal $name not present")
-}
+}

lifecycletracker/src/iosMain/kotlin/com.multiplatform.lifecyle/LifecycleComposeUIVCDelegate.kt

@@ -14,7 +14,7 @@ import platform.UIKit.UIApplicationWillResignActiveNotification
 import platform.UIKit.UIApplicationWillTerminateNotification
 
 /**
- * Created By Kevin Zou On 2024/2/22
+ * A delegate for handling iOS lifecycle events in a Compose UI View Controller.
  */
 class LifecycleComposeUIVCDelegate(private val lifecycleTracker: LifecycleTracker) :
     ComposeUIViewControllerDelegate {

lifecycletracker/src/iosMain/kotlin/com.multiplatform.lifecyle/NSLifecycleListener.kt

@@ -8,7 +8,7 @@ import platform.Foundation.NSNotification
 import platform.darwin.NSObject
 
 /**
- * Created By Kevin Zou On 2024/2/26
+ * A listener for iOS lifecycle events.
  */
 @Suppress("unused")
 @OptIn(BetaInteropApi::class)