From bdfbac07d91815cadaf5f986cf0c47a395195128 Mon Sep 17 00:00:00 2001 From: Sebastian Sellmair Date: Mon, 19 Sep 2022 15:34:59 +0200 Subject: [PATCH] [Gradle] Add ReadMe.md to k.g.p-annotations module ^KT-54029 Verification Pending --- .../kotlin-gradle-plugin-annotations/ReadMe.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) create mode 100644 libraries/tools/kotlin-gradle-plugin-annotations/ReadMe.md diff --git a/libraries/tools/kotlin-gradle-plugin-annotations/ReadMe.md b/libraries/tools/kotlin-gradle-plugin-annotations/ReadMe.md new file mode 100644 index 00000000000..bdc66e0d068 --- /dev/null +++ b/libraries/tools/kotlin-gradle-plugin-annotations/ReadMe.md @@ -0,0 +1,15 @@ +## Gradle Plugin Annotations + +Contains all necessary annotations related to the Kotlin Gradle Plugin and modules around it. +This module has no dependencies and can therefore be considered very lightweight. + +### API Surface Control Annotations + +#### InternalKotlinGradlePluginApi +Can be used to mark APIs as 'internal' where an 'internal' modifier cannot be used +(e.g. when entities need to be re-used across several modules within kotlin.git) + + +#### ExperimentalKotlinGradlePluginApi +Can be used to mark APIs as 'experimental'. No stability guarantees can be provided +for APIs marked with this annotation \ No newline at end of file