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

IntentionallyUndocumented

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

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

Acknowledges that the annotated declaration is deliberately left without KDoc.

The library-api-watchdog compiler plugin warns about publicly visible declarations that have no KDoc - classifiers, type aliases, functions, properties, constructors, and enum entries - because undocumented API forces users to guess the usage contract. Apply this annotation to suppress the warning when leaving the declaration undocumented is intended (for example, when it is self-explanatory or documented elsewhere).

See the check documentation for rationale and examples.

Parameters

reason

why the declaration is deliberately undocumented.

description

free-form explanation of the exemption. May be empty only when reason explains the exemption on its own (ExemptionReason.FOR_BACKWARDS_COMPATIBILITY, ExemptionReason.API_DESIGN).

Properties

description

val description: String

reason

val reason: ExemptionReason