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

Package-level declarations

Types

enum ExemptionReason : Enum<ExemptionReason>

Explains why a watchdog exemption annotation is applied.

@Target(allowedTargets = [AnnotationTarget.FUNCTION, AnnotationTarget.VALUE_PARAMETER])

annotation class IntentionallyBooleanParameter(val reason: ExemptionReason = ExemptionReason.OTHER, val description: String = "")

Acknowledges that the annotated function or parameter deliberately takes a Boolean argument.

IntentionallyDataClass

@Target(allowedTargets = [AnnotationTarget.CLASS])

annotation class IntentionallyDataClass(val reason: ExemptionReason = ExemptionReason.OTHER, val description: String = "")

Acknowledges that the annotated data class is deliberately part of the public API.

IntentionallyDefaultFacadeName

@Target(allowedTargets = [AnnotationTarget.FILE])

annotation class IntentionallyDefaultFacadeName(val reason: ExemptionReason = ExemptionReason.OTHER, val description: String = "")

Acknowledges that the annotated file deliberately keeps the file facade class name derived from the file name.

IntentionallyExhaustive

@Target(allowedTargets = [AnnotationTarget.CLASS])

annotation class IntentionallyExhaustive(val reason: ExemptionReason = ExemptionReason.OTHER, val description: String = "")

Acknowledges that the annotated enum or sealed hierarchy is deliberately exhaustive.

IntentionallyFunctionTypeAlias

@Target(allowedTargets = [AnnotationTarget.TYPEALIAS])

annotation class IntentionallyFunctionTypeAlias(val reason: ExemptionReason = ExemptionReason.OTHER, val description: String = "")

Acknowledges that the annotated type alias deliberately exposes a bare function type.

IntentionallyInconsistentParameterOrder

@Target(allowedTargets = [AnnotationTarget.FUNCTION, AnnotationTarget.CONSTRUCTOR])

annotation class IntentionallyInconsistentParameterOrder(val reason: ExemptionReason = ExemptionReason.OTHER, val description: String = "")

Acknowledges that the annotated function or constructor deliberately orders its parameters differently from its other overloads.

IntentionallyInlinedLogic

@Target(allowedTargets = [AnnotationTarget.FUNCTION, AnnotationTarget.PROPERTY])

annotation class IntentionallyInlinedLogic(val reason: ExemptionReason = ExemptionReason.OTHER, val description: String = "")

Acknowledges that the annotated inline function or the annotated property's inline accessors deliberately carry logic in their body.

IntentionallyKotlinOnlyApi

@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.FUNCTION])

annotation class IntentionallyKotlinOnlyApi(val reason: ExemptionReason = ExemptionReason.OTHER, val description: String = "")

Acknowledges that the annotated function - or every function inside the annotated class - is deliberately Kotlin-only API left visible to Java sources.

IntentionallyMangledJvmName

@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.FUNCTION, AnnotationTarget.PROPERTY, AnnotationTarget.CONSTRUCTOR, AnnotationTarget.VALUE_PARAMETER])

annotation class IntentionallyMangledJvmName(val reason: ExemptionReason = ExemptionReason.OTHER, val description: String = "")

Acknowledges that the annotated declaration deliberately compiles to a JVM shape that Java sources can't call.

IntentionallyMutableCollection

@Target(allowedTargets = [AnnotationTarget.FUNCTION, AnnotationTarget.PROPERTY, AnnotationTarget.CONSTRUCTOR, AnnotationTarget.VALUE_PARAMETER, AnnotationTarget.TYPE_PARAMETER, AnnotationTarget.TYPE])

annotation class IntentionallyMutableCollection(val reason: ExemptionReason = ExemptionReason.OTHER, val description: String = "")

Acknowledges that the annotated declaration deliberately exposes a mutable collection type in the public API.

IntentionallyNonStaticCompanionApi

@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.FUNCTION, AnnotationTarget.PROPERTY])

annotation class IntentionallyNonStaticCompanionApi(val reason: ExemptionReason = ExemptionReason.OTHER, val description: String = "")

Acknowledges that the annotated companion object member - or every member inside the annotated companion object or class - is deliberately reachable from Java only through the companion instance.

IntentionallyNullableBoolean

annotation class IntentionallyNullableBoolean(val reason: ExemptionReason = ExemptionReason.OTHER, val description: String = "")

Acknowledges that the annotated declaration deliberately exposes a nullable Boolean in the public API.

IntentionallyOpen

@Target(allowedTargets = [AnnotationTarget.CLASS])

annotation class IntentionallyOpen(val reason: ExemptionReason = ExemptionReason.OTHER, val description: String = "")

Acknowledges that the annotated class or interface is deliberately open for unrestricted subclassing outside the library.

IntentionallyPairOrTriple

annotation class IntentionallyPairOrTriple(val reason: ExemptionReason = ExemptionReason.OTHER, val description: String = "")

Acknowledges that the annotated declaration deliberately exposes the tuple type Pair or Triple in the public API.

IntentionallyRequiredParameterAfterOptional

@Target(allowedTargets = [AnnotationTarget.FUNCTION, AnnotationTarget.CONSTRUCTOR])

annotation class IntentionallyRequiredParameterAfterOptional(val reason: ExemptionReason = ExemptionReason.OTHER, val description: String = "")

Acknowledges that the annotated function or constructor deliberately declares a required parameter after optional ones.

IntentionallyUndocumented

@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.TYPEALIAS, AnnotationTarget.FUNCTION, AnnotationTarget.PROPERTY, AnnotationTarget.CONSTRUCTOR])

annotation class IntentionallyUndocumented(val reason: ExemptionReason = ExemptionReason.OTHER, val description: String = "")

Acknowledges that the annotated declaration is deliberately left without KDoc.

IntentionallyWithoutEquals

@Target(allowedTargets = [AnnotationTarget.CLASS])

annotation class IntentionallyWithoutEquals(val reason: ExemptionReason = ExemptionReason.OTHER, val description: String = "")

Acknowledges that the annotated stateful class deliberately uses identity equality.

IntentionallyWithoutEqualsHashCodeOrToString

@Target(allowedTargets = [AnnotationTarget.CLASS])

annotation class IntentionallyWithoutEqualsHashCodeOrToString(val reason: ExemptionReason = ExemptionReason.OTHER, val description: String = "")

Acknowledges that the annotated stateful class deliberately uses identity equality and hashing and the opaque default rendering inherited from kotlin.Any.

IntentionallyWithoutHashCode

@Target(allowedTargets = [AnnotationTarget.CLASS])

annotation class IntentionallyWithoutHashCode(val reason: ExemptionReason = ExemptionReason.OTHER, val description: String = "")

Acknowledges that the annotated stateful class deliberately uses identity hashing.

IntentionallyWithoutJvmOverloads

@Target(allowedTargets = [AnnotationTarget.FUNCTION, AnnotationTarget.CONSTRUCTOR])

annotation class IntentionallyWithoutJvmOverloads(val reason: ExemptionReason = ExemptionReason.OTHER, val description: String = "")

Acknowledges that the annotated function or constructor deliberately keeps its default parameter values invisible to Java callers.

IntentionallyWithoutToString

@Target(allowedTargets = [AnnotationTarget.CLASS])

annotation class IntentionallyWithoutToString(val reason: ExemptionReason = ExemptionReason.OTHER, val description: String = "")

Acknowledges that the annotated class deliberately provides no toString implementation.

IntentionallyWrongDslMarkerTargetsForBackwardsCompatibility

@Target(allowedTargets = [AnnotationTarget.ANNOTATION_CLASS])

annotation class IntentionallyWrongDslMarkerTargetsForBackwardsCompatibility(val description: String = "")

Acknowledges that the annotated DSL marker deliberately keeps a wrong target set - no-op targets in its @Target, or no explicit @Target at all - because fixing it would break existing users.

InternalAnnotationMarker

@Target(allowedTargets = [AnnotationTarget.ANNOTATION_CLASS])

annotation class InternalAnnotationMarker

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.