📝: add comments

Author: junerver

hooks/src/commonMain/kotlin/xyz/junerver/compose/hooks/declare.kt

@@ -42,7 +42,7 @@ fun <TData : Any> rememberRequest(
 
 //region useAsync
 @Composable
-fun rememberAsync(fn: SuspendAsyncFn) = useAsync(fn)
+fun rememberAsync(block: SuspendAsyncFn) = useAsync(block)
 
 @Composable
 fun rememberAsync(): AsyncRunFn = useAsync()
@@ -133,7 +133,7 @@ fun <K, V> rememberMap(pairs: Iterable<Pair<K, V>>) = useMap(pairs)
 //endregion
 
 @Composable
-fun rememberMount(fn: SuspendAsyncFn) = useMount(fn)
+fun rememberMount(block: SuspendAsyncFn) = useMount(block)
 
 @Composable
 fun rememberNow(optionsOf: UseNowOptions.() -> Unit = {}) = useNow(optionsOf)

hooks/src/commonMain/kotlin/xyz/junerver/compose/hooks/useAsync.kt

@@ -20,13 +20,13 @@ import kotlinx.coroutines.launch
  * async()
  * ```
  *
- * @param fn
+ * @param block
  * @return
  * @receiver
  */
 @Composable
-fun useAsync(fn: SuspendAsyncFn): () -> Unit {
-    val latestFn by useLatestState(value = fn)
+fun useAsync(block: SuspendAsyncFn): () -> Unit {
+    val latestFn by useLatestState(value = block)
     val asyncRunFn = useAsync()
     return fun () {
         asyncRunFn {

hooks/src/commonMain/kotlin/xyz/junerver/compose/hooks/useAutoReset.kt

@@ -13,6 +13,27 @@ import kotlinx.coroutines.delay
   Version: v1.0
 */
 
+/**
+ * A composable function that automatically resets a state value to its default
+ * value after a specified duration (interval).
+ *
+ * This function can be used to reset a value back to its default state after a given
+ * time period has passed, making it useful for situations where you want to restore
+ * the state to its initial condition after a certain amount of time.
+ *
+ * @param default The default value of type `T` that the state will reset to.
+ * @param interval The `Duration` indicating the time period after which the state
+ *                 will be reset to the `default` value.
+ *
+ * @return A `MutableState<T>` that holds the current state value, which will be
+ *         automatically reset to `default` after the specified interval.
+ *
+ * Example usage:
+ * ```kotlin
+ * var autoResetState by useAutoReset(0, 5.seconds)
+ * autoResetState = 1
+ * ```
+ */
 @Composable
 fun <T> useAutoReset(default: T & Any, interval: Duration): MutableState<T & Any> {
     val state = useState(default = default)

hooks/src/commonMain/kotlin/xyz/junerver/compose/hooks/useBackFront.kt

@@ -44,7 +44,6 @@ fun useBackToFrontEffect(vararg deps: Any?, effect: () -> Unit) {
  * @param effect
  * @receiver
  */
-
 @Composable
 fun useFrontToBackEffect(vararg deps: Any?, effect: () -> Unit) {
     var inBackgroundRef by useRef(default = false)

hooks/src/commonMain/kotlin/xyz/junerver/compose/hooks/useBoolean.kt

@@ -13,6 +13,30 @@ import androidx.compose.runtime.remember
   Version: v1.0
 */
 
+/**
+ * A composable function that provides a state holder for a boolean value
+ * with various utility functions to manipulate the state.
+ *
+ * This function allows you to easily manage a boolean state with operations
+ * like toggling, setting it to `true`, or setting it to `false`. It is useful
+ * for scenarios where you need to track and manipulate a boolean state in a
+ * composable function.
+ *
+ * @param default The default boolean value for the state. Default is `false`.
+ *
+ * @return A [BooleanHolder] object that contains:
+ * - `state`: The current boolean state value.
+ * - `toggle`: A function that toggles the state between `true` and `false`.
+ * - `setValue`: A function to set the state to a specified boolean value.
+ * - `setTrue`: A function to set the state to `true`.
+ * - `setFalse`: A function to set the state to `false`.
+ *
+ * Example usage:
+ * ```kotlin
+ * val (booleanState, toggle) = useBoolean(true)
+ * toggle()  // Will change the state to false.
+ * ```
+ */
 @Composable
 fun useBoolean(default: Boolean = false): BooleanHolder {
     val (state, setState, getState) = useGetState(default)

hooks/src/commonMain/kotlin/xyz/junerver/compose/hooks/useClipboard.kt

@@ -7,7 +7,23 @@ import androidx.compose.ui.platform.LocalClipboardManager
 import androidx.compose.ui.text.AnnotatedString
 
 /**
- * 快捷的使用剪切板：复制、粘贴
+ * A composable function that provides access to clipboard operations
+ * like copying and pasting text using the system clipboard manager.
+ *
+ * This function allows you to interact with the device's clipboard. You can
+ * easily copy text to the clipboard or retrieve the text from the clipboard
+ * using this helper function.
+ *
+ * @return A `CopyPasteHolder` object that contains:
+ *         - `copy`: A function that copies the provided text to the clipboard.
+ *         - `paste`: A function that retrieves the text from the clipboard.
+ *
+ * Example usage:
+ * ```kotlin
+ * val (copy, paste) = useClipboard()
+ * copy("Hello, world!") // Copies "Hello, world!" to the clipboard.
+ * val pastedText = paste() // Retrieves text from the clipboard.
+ * ```
  */
 @Composable
 fun useClipboard(): CopyPasteHolder {

hooks/src/commonMain/kotlin/xyz/junerver/compose/hooks/useMount.kt

@@ -11,4 +11,4 @@ import androidx.compose.runtime.Composable
 */
 
 @Composable
-fun useMount(fn: SuspendAsyncFn) = useEffect(Unit) { fn() }
+fun useMount(block: SuspendAsyncFn) = useEffect(Unit) { block() }