Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 5ecbc5f7 authored by Ale Nijamkin's avatar Ale Nijamkin Committed by Android (Google) Code Review
Browse files

Merge "Adds some missing doc" into main

parents 770e8b57 c13087d5
Loading
Loading
Loading
Loading
+13 −0
Original line number Diff line number Diff line
@@ -30,6 +30,12 @@ import kotlinx.coroutines.launch
/** Base class for all System UI view-models. */
abstract class SysUiViewModel : BaseActivatable() {

    /**
     * Returns a snapshot [State] that's kept up-to-date as long as the [SysUiViewModel] is active.
     *
     * @param source The upstream [StateFlow] to collect from; values emitted to it will be
     *   automatically set on the returned [State].
     */
    @StateFactoryMarker
    fun <T> hydratedStateOf(
        source: StateFlow<T>,
@@ -40,6 +46,13 @@ abstract class SysUiViewModel : BaseActivatable() {
        )
    }

    /**
     * Returns a snapshot [State] that's kept up-to-date as long as the [SysUiViewModel] is active.
     *
     * @param initialValue The first value to place on the [State]
     * @param source The upstream [Flow] to collect from; values emitted to it will be automatically
     *   set on the returned [State].
     */
    @StateFactoryMarker
    fun <T> hydratedStateOf(
        initialValue: T,