Browse Source

Update Preview.kt doc (#5346)

Follow-up after
https://github.com/JetBrains/compose-multiplatform/pull/5339#discussion_r2175277763

## Release Notes
N/A
pull/5226/merge
Igor Demin 6 months ago committed by GitHub
parent
commit
a5ab22a240
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
  1. 6
      components/ui-tooling-preview/library/src/commonMain/kotlin/org/jetbrains/compose/ui/tooling/preview/Preview.kt

6
components/ui-tooling-preview/library/src/commonMain/kotlin/org/jetbrains/compose/ui/tooling/preview/Preview.kt

@ -18,14 +18,14 @@ package org.jetbrains.compose.ui.tooling.preview @@ -18,14 +18,14 @@ package org.jetbrains.compose.ui.tooling.preview
/**
* [Preview] can be applied to either of the following:
* - @[Composable] methods with no parameters to show them in the Android Studio preview.
* - @[Composable] methods with no parameters to show them in the IDE preview.
* - Annotation classes, that could then be used to annotate @[Composable] methods or other
* annotation classes, which will then be considered as indirectly annotated with that [Preview].
*
* The annotation contains a number of parameters that allow to define the way the @[Composable]
* will be rendered within the preview.
*
* The passed parameters are only read by Studio when rendering the preview.
* The passed parameters are only read by IDE when rendering the preview.
*
* @param name Display name of this preview allowing to identify it in the panel.
* @param group Group name for this @[Preview]. This allows grouping them in the UI and display only
@ -53,4 +53,4 @@ annotation class Preview( @@ -53,4 +53,4 @@ annotation class Preview(
val locale: String = "",
val showBackground: Boolean = false,
val backgroundColor: Long = 0,
)
)

Loading…
Cancel
Save