kotlin-library-api-watchdog-plugin-annotations/org.jetbrains.kotlinx.libs.api.watchdog/InternalAnnotationMarker

InternalAnnotationMarker

@Target(allowedTargets = [AnnotationTarget.ANNOTATION_CLASS])

annotation class InternalAnnotationMarker(source)

Turns the annotated annotation class into an internal API marker: declarations annotated with the marked annotation, and everything nested in them, are exempt from all public API checks.

Libraries sometimes expose declarations that are public for technical reasons but are not part of the supported API surface, and flag them with a dedicated annotation (usually one that also requires opt-in). Such declarations carry no compatibility contract, so the library-api-watchdog compiler plugin shouldn't demand documentation or evolution safeguards for them:

@InternalAnnotationMarker
@RequiresOptIn(level = RequiresOptIn.Level.ERROR)
public annotation class InternalMyLibraryApi

@InternalMyLibraryApi // Not watched: internal API despite the public visibility.
public class ReflectionHelper

The marker annotation class itself remains part of the public API surface and is still watched.

See Exemptions and internal API for details.