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