Add KDoc to core utils

Author: w2sv

composed-core/src/main/kotlin/com/w2sv/composed/core/DisposableEffect.kt

@@ -10,7 +10,10 @@ import androidx.lifecycle.LifecycleOwner
 import androidx.lifecycle.compose.LocalLifecycleOwner
 
 /**
- * Run the given [callback] inside of a [LifecycleEventObserver] launched as a [DisposableEffect], when the [lifecycleOwner] reaches the given [lifecycleEvent] and clean up the observer when [lifecycleOwner], [key1] or [key2] changes or if [OnLifecycleEvent] leaves the composition.
+ * Run the given [callback] inside of a [LifecycleEventObserver] launched as a [DisposableEffect], when the [lifecycleOwner] reaches the
+ * given [lifecycleEvent] and clean up the observer when [lifecycleOwner], [key1] or [key2] changes or if [OnLifecycleEvent] leaves the
+ * composition.
+ *
  * @see DisposableEffect
  */
 @Composable
@@ -38,6 +41,12 @@ fun OnLifecycleEvent(
     }
 }
 
+/**
+ * Executes [callback] when the current composition leaves the composition.
+ *
+ * This is a convenience wrapper around `DisposableEffect(Unit)` that ensures
+ * the latest provided [callback] is invoked during disposal.
+ */
 @Composable
 fun OnDispose(callback: () -> Unit) {
     val currentCallback by rememberUpdatedState(newValue = callback)

composed-core/src/main/kotlin/com/w2sv/composed/core/LaunchedEffect.kt

@@ -41,6 +41,12 @@ fun <T> CollectLatestFromFlow(
     }
 }
 
+/**
+ * Runs [callback] whenever [value] or one of the optional keys changes.
+ *
+ * This behaves like a [LaunchedEffect] tied to [value], ensuring the latest
+ * [callback] is invoked with the updated value.
+ */
 @Composable
 fun <T> OnChange(
     value: T,

composed-core/src/main/kotlin/com/w2sv/composed/core/Orientation.kt

@@ -5,11 +5,17 @@ import androidx.compose.runtime.Composable
 import androidx.compose.runtime.ReadOnlyComposable
 import androidx.compose.ui.platform.LocalConfiguration
 
+/**
+ * @return `true` when the current configuration is in landscape orientation.
+ */
 val isLandscapeModeActive: Boolean
     @Composable
     @ReadOnlyComposable
     get() = LocalConfiguration.current.orientation == Configuration.ORIENTATION_LANDSCAPE
 
+/**
+ * @return `true` when the current configuration is in portrait orientation.
+ */
 val isPortraitModeActive: Boolean
     @Composable
     @ReadOnlyComposable

composed-core/src/main/kotlin/com/w2sv/composed/core/Saver.kt

@@ -29,9 +29,9 @@ fun nullableColorSaver() =
 /**
  * [listSaver] for an optional object of type [Original], that enables you to omit the handling of the case in which the state value == null. Only the saving and restoring of the non-null instance needs to be handled.
  */
-fun <Original, Saveable> nullableListSaver(
-    saveNonNull: SaverScope.(value: Original) -> List<Saveable>,
-    restoreNonNull: (list: List<Saveable>) -> Original?
+fun <Original, Savable> nullableListSaver(
+    saveNonNull: SaverScope.(value: Original) -> List<Savable>,
+    restoreNonNull: (list: List<Savable>) -> Original?
 ): Saver<Original?, Any> =
     listSaver(
         save = { original ->

composed-core/src/main/kotlin/com/w2sv/composed/core/extensions/DimensionConversion.kt

@@ -5,16 +5,25 @@ import androidx.compose.runtime.ReadOnlyComposable
 import androidx.compose.ui.platform.LocalDensity
 import androidx.compose.ui.unit.Dp
 
+/**
+ * Converts this [Dp] value to raw pixels using the current [LocalDensity].
+ */
 @Composable
 @ReadOnlyComposable
 fun Dp.toPx() =
     with(LocalDensity.current) { this@toPx.toPx() }
 
+/**
+ * Converts this pixel value to [Dp] using the current [LocalDensity].
+ */
 @Composable
 @ReadOnlyComposable
 fun Int.toDp() =
     with(LocalDensity.current) { this@toDp.toDp() }
 
+/**
+ * Converts this pixel value to [Dp] using the current [LocalDensity].
+ */
 @Composable
 @ReadOnlyComposable
 fun Float.toDp() =

composed-core/src/main/kotlin/com/w2sv/composed/core/extensions/Map.kt

@@ -3,6 +3,9 @@ package com.w2sv.composed.core.extensions
 import androidx.compose.runtime.mutableStateMapOf
 import androidx.compose.runtime.snapshots.SnapshotStateMap
 
+/**
+ * Converts this [Map] to a [SnapshotStateMap].
+ */
 fun <K, V> Map<K, V>.toMutableStateMap(): SnapshotStateMap<K, V> =
     mutableStateMapOf<K, V>()
         .apply { putAll(this@toMutableStateMap) }

composed-core/src/main/kotlin/com/w2sv/composed/core/extensions/TimeInterpolator.kt

@@ -3,5 +3,9 @@ package com.w2sv.composed.core.extensions
 import android.animation.TimeInterpolator
 import androidx.compose.animation.core.Easing
 
+/**
+ * Converts a [TimeInterpolator] from the View animation system into a Compose [Easing].
+ * This allows existing interpolators to be reused in Compose animation specs.
+ */
 fun TimeInterpolator.toEasing() =
     Easing { getInterpolation(it) }