summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
author Steve Elliott <steell@google.com> 2024-12-09 21:39:17 +0000
committer Android (Google) Code Review <android-gerrit@google.com> 2024-12-09 21:39:17 +0000
commit003da44ff0458e05caad7f082ac7fa2f622d29fc (patch)
tree94bc8f2a52c7bda7b4b508f69b84abaa81303329
parentad777fc2759320d6f1d023bbb4413c432b6cd4d1 (diff)
parent874e1050cd474375c0bff955d1c26814ae3cf42e (diff)
Merge "[kairos] Fixup KDocs" into main
-rw-r--r--packages/SystemUI/utils/kairos/src/com/android/systemui/kairos/FrpEffectScope.kt9
-rw-r--r--packages/SystemUI/utils/kairos/src/com/android/systemui/kairos/TState.kt2
2 files changed, 6 insertions, 5 deletions
diff --git a/packages/SystemUI/utils/kairos/src/com/android/systemui/kairos/FrpEffectScope.kt b/packages/SystemUI/utils/kairos/src/com/android/systemui/kairos/FrpEffectScope.kt
index be2eb4312476..b39dcc131b1d 100644
--- a/packages/SystemUI/utils/kairos/src/com/android/systemui/kairos/FrpEffectScope.kt
+++ b/packages/SystemUI/utils/kairos/src/com/android/systemui/kairos/FrpEffectScope.kt
@@ -22,16 +22,17 @@ import kotlinx.coroutines.CoroutineScope
/**
* Scope for external side-effects triggered by the Frp network. This still occurs within the
* context of a transaction, so general suspending calls are disallowed to prevent blocking the
- * transaction. You can use [frpCoroutineScope] to [launch] new coroutines to perform long-running
- * asynchronous work. This scope is alive for the duration of the containing [FrpBuildScope] that
- * this side-effect scope is running in.
+ * transaction. You can use [frpCoroutineScope] to [launch][kotlinx.coroutines.launch] new
+ * coroutines to perform long-running asynchronous work. This scope is alive for the duration of the
+ * containing [FrpBuildScope] that this side-effect scope is running in.
*/
@RestrictsSuspension
@ExperimentalFrpApi
interface FrpEffectScope : FrpTransactionScope {
/**
* A [CoroutineScope] whose lifecycle lives for as long as this [FrpEffectScope] is alive. This
- * is generally until the [Job] returned by [FrpBuildScope.effect] is cancelled.
+ * is generally until the [Job][kotlinx.coroutines.Job] returned by [FrpBuildScope.effect] is
+ * cancelled.
*/
@ExperimentalFrpApi val frpCoroutineScope: CoroutineScope
diff --git a/packages/SystemUI/utils/kairos/src/com/android/systemui/kairos/TState.kt b/packages/SystemUI/utils/kairos/src/com/android/systemui/kairos/TState.kt
index 34bd509806b9..80e74748a375 100644
--- a/packages/SystemUI/utils/kairos/src/com/android/systemui/kairos/TState.kt
+++ b/packages/SystemUI/utils/kairos/src/com/android/systemui/kairos/TState.kt
@@ -121,7 +121,7 @@ fun <A, B, C> TState<A>.combineWith(
/**
* Splits a [TState] of pairs into a pair of [TFlows][TState], where each returned [TState] holds
- * hald of the original.
+ * half of the original.
*
* Shorthand for:
* ```kotlin