Merge "Fix formatting of Lifecycle*Effect KDocs" into androidx-main

dlam · Oct 13, 2023 · 2eb0989 · 2eb0989
2 parents 7609753 + f370538
commit 2eb0989
Showing 1 changed file with 16 additions and 0 deletions.
diff --git a/...cle/lifecycle-runtime-compose/src/main/java/androidx/lifecycle/compose/LifecycleEffect.kt b/...cle/lifecycle-runtime-compose/src/main/java/androidx/lifecycle/compose/LifecycleEffect.kt
@@ -87,13 +87,15 @@ fun LifecycleEventEffect(
  * block and the ON_STOP effect will be within the
  * (onStopOrDispose clause)[LifecycleStartStopEffectScope.onStopOrDispose]:
  *
+ * ```
  * LifecycleStartEffect(lifecycleOwner) {
  *     // add ON_START effect here
  *
  *     onStopOrDispose {
  *         // add clean up for work kicked off in the ON_START effect here
  *     }
  * }
+ * ```
  *
  * @sample androidx.lifecycle.compose.samples.lifecycleStartEffectSample
  *
@@ -146,13 +148,15 @@ fun LifecycleStartEffect(
  * [effects] block and the ON_STOP effect will be within the
  * (onStopOrDispose clause)[LifecycleStartStopEffectScope.onStopOrDispose]:
  *
+ * ```
  * LifecycleStartEffect(lifecycleOwner) {
  *     // add ON_START effect here
  *
  *     onStopOrDispose {
  *         // add clean up for work kicked off in the ON_START effect here
  *     }
  * }
+ * ```
  *
  * @sample androidx.lifecycle.compose.samples.lifecycleStartEffectSample
  *
@@ -207,13 +211,15 @@ fun LifecycleStartEffect(
  * of the [effects] block and the ON_STOP effect will be within the
  * (onStopOrDispose clause)[LifecycleStartStopEffectScope.onStopOrDispose]:
  *
+ * ```
  * LifecycleStartEffect(lifecycleOwner) {
  *     // add ON_START effect here
  *
  *     onStopOrDispose {
  *         // add clean up for work kicked off in the ON_START effect here
  *     }
  * }
+ * ```
  *
  * @sample androidx.lifecycle.compose.samples.lifecycleStartEffectSample
  *
@@ -270,13 +276,15 @@ fun LifecycleStartEffect(
  * block and the ON_STOP effect will be within the
  * (onStopOrDispose clause)[LifecycleStartStopEffectScope.onStopOrDispose]:
  *
+ * ```
  * LifecycleStartEffect(lifecycleOwner) {
  *     // add ON_START effect here
  *
  *     onStopOrDispose {
  *         // add clean up for work kicked off in the ON_START effect here
  *     }
  * }
+ * ```
  *
  * @sample androidx.lifecycle.compose.samples.lifecycleStartEffectSample
  *
@@ -391,13 +399,15 @@ class LifecycleStartStopEffectScope(override val lifecycle: Lifecycle) : Lifecyc
  * block and the ON_PAUSE effect will be within the
  * (onPauseOrDispose clause)[LifecycleResumePauseEffectScope.onPauseOrDispose]:
  *
+ * ```
  * LifecycleResumeEffect(lifecycleOwner) {
  *     // add ON_RESUME effect here
  *
  *     onPauseOrDispose {
  *         // add clean up for work kicked off in the ON_RESUME effect here
  *     }
  * }
+ * ```
  *
  * @sample androidx.lifecycle.compose.samples.lifecycleResumeEffectSample
  *
@@ -450,13 +460,15 @@ fun LifecycleResumeEffect(
  * [effects] block and the ON_PAUSE effect will be within the
  * (onPauseOrDispose clause)[LifecycleResumePauseEffectScope.onPauseOrDispose]:
  *
+ * ```
  * LifecycleResumeEffect(lifecycleOwner) {
  *     // add ON_RESUME effect here
  *
  *     onPauseOrDispose {
  *         // add clean up for work kicked off in the ON_RESUME effect here
  *     }
  * }
+ * ```
  *
  * @sample androidx.lifecycle.compose.samples.lifecycleResumeEffectSample
  *
@@ -511,13 +523,15 @@ fun LifecycleResumeEffect(
  * of the [effects] block and the ON_PAUSE effect will be within the
  * (onPauseOrDispose clause)[LifecycleResumePauseEffectScope.onPauseOrDispose]:
  *
+ * ```
  * LifecycleResumeEffect(lifecycleOwner) {
  *     // add ON_RESUME effect here
  *
  *     onPauseOrDispose {
  *         // add clean up for work kicked off in the ON_RESUME effect here
  *     }
  * }
+ * ```
  *
  * @sample androidx.lifecycle.compose.samples.lifecycleResumeEffectSample
  *
@@ -574,13 +588,15 @@ fun LifecycleResumeEffect(
  * block and the ON_PAUSE effect will be within the
  * (onPauseOrDispose clause)[LifecycleResumePauseEffectScope.onPauseOrDispose]:
  *
+ * ```
  * LifecycleResumeEffect(lifecycleOwner) {
  *     // add ON_RESUME effect here
  *
  *     onPauseOrDispose {
  *         // add clean up for work kicked off in the ON_RESUME effect here
  *     }
  * }
+ * ```
  *
  * @sample androidx.lifecycle.compose.samples.lifecycleResumeEffectSample
  *