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

Commit 003da44f authored by Steve Elliott's avatar Steve Elliott Committed by Android (Google) Code Review
Browse files

Merge "[kairos] Fixup KDocs" into main

parents ad777fc2 874e1050
Loading
Loading
Loading
Loading
+5 −4
Original line number Diff line number Diff line
@@ -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

+1 −1
Original line number Diff line number Diff line
@@ -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