Merge "Adds some missing doc" into main

1 files changed, 13 insertions, 0 deletions

diff --git a/packages/SystemUI/src/com/android/systemui/lifecycle/SysUiViewModel.kt b/packages/SystemUI/src/com/android/systemui/lifecycle/SysUiViewModel.kt
index 32c476093774..979eaef30a23 100644
--- a/packages/SystemUI/src/com/android/systemui/lifecycle/SysUiViewModel.kt
+++ b/packages/SystemUI/src/com/android/systemui/lifecycle/SysUiViewModel.kt
@@ -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,