Package-level declarations

Types

Link copied to clipboard
@DisableCachingByDefault(because = "Reads diagnostic reports that Kotlin compile tasks don't declare as outputs")
abstract class ApiWatchdogReportTask : DefaultTask
Link copied to clipboard
@UntrackedTask(because = "Rewrites the Kotlin sources it analyzes")
abstract class ExemptExistingApiTask : ApiWatchdogReportTask

The exemptExistingApi task. It exempts every watchdog error in the Kotlin sources of every compilation except tests: the matching @Intentionally* annotation with reason = ExemptionReason.FOR_BACKWARDS_COMPATIBILITY, or a placeholder KDoc for UNDOCUMENTED_PUBLIC_API. Then it writes the API Watchdog report. It doesn't exempt warnings. Use it when you adopt the watchdog on a library with a released API.

Link copied to clipboard
@UntrackedTask(because = "Reads the diagnostic reports that the Kotlin compile tasks write")
abstract class GenerateApiWatchdogReportTask : ApiWatchdogReportTask

The generateApiWatchdogReport task. It writes the API Watchdog report of the project: the applied @Intentionally* annotations and the diagnostics without one. It doesn't change any source.

Link copied to clipboard

The apiWatchdog block: the enabled switch and the severity of each configurable diagnostic. Default severity is WatchdogSeverity.ERROR unless the property states another.

Link copied to clipboard

The javaInterop block of WatchdogGradleExtension: the Java-interop diagnostics. They matter only to Java consumers, so a Kotlin-only library turns them off:

Link copied to clipboard

The severity of a watchdog diagnostic.

Link copied to clipboard
class WatchdogSupportPlugin : DevKitSupportPlugin

The org.jetbrains.kotlin.library.api-watchdog plugin.