1 /*
2  * Copyright 2021 The Android Open Source Project
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  *      http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 
17 package androidx.compose.runtime
18 
19 /**
20  * This annotation is used to mark an annotation as being equivalent using [ComposableTarget] with
21  * the fully qualified name of the marked annotation as the `applier` value. See [ComposableTarget]
22  * for when a [ComposableTarget] annotation is required and when it can be inferred by the Compose
23  * compiler plugin.
24  *
25  * The [description] value can be used to supply a string that is used to describe the group of
26  * composable function instead of applier parameter of the [ComposableTarget]. See UiComposable and
27  * VectorComposable for examples. If no description is provided, the fully-qualified name of the
28  * marked annotation is used instead.
29  */
30 @Retention(AnnotationRetention.BINARY)
31 @Target(AnnotationTarget.ANNOTATION_CLASS)
32 annotation class ComposableTargetMarker(val description: String = "")
33