kotlin-gradle-plugin-api/org.jetbrains.kotlin.gradle.dsl/KaptExtensionConfig

KaptExtensionConfig

A plugin DSL extension for configuring kapt annotation processing.

Use the extension in your build script in the kapt block:

kapt {
   // Your extension configuration
}

Properties

correctErrorTypes

abstract var correctErrorTypes: Boolean

Replaces any generated error types with error types from the generated sources.

detectMemoryLeaks

abstract var detectMemoryLeaks: String

Detects memory leaks in annotation processors.

dumpDefaultParameterValues

abstract var dumpDefaultParameterValues: Boolean

Adds initializers to fields whose corresponding primary constructor parameters have a default value specified.

includeCompileClasspath

abstract var includeCompileClasspath: Boolean?

Also loads annotation processors from compile classpath.

keepJavacAnnotationProcessors

abstract var keepJavacAnnotationProcessors: Boolean

Keeps annotation processors that are added via the annotationProcessor(..) configuration for javac java-files compilation

mapDiagnosticLocations

abstract var mapDiagnosticLocations: Boolean

Maps diagnostics reported on kapt stubs to their original locations in Kotlin sources.

showProcessorStats

abstract var showProcessorStats: Boolean

Shows annotation processor statistics in the verbose kapt log output.

strictMode

abstract var strictMode: Boolean

Reports any incompatibility errors found during stub generation.

stripMetadata

abstract var stripMetadata: Boolean

Strips @Metadata annotations from stubs.

useBuildCache

abstract var useBuildCache: Boolean

Uses the Gradle build cache feature for kapt tasks.

useLightAnalysis

abstract var useLightAnalysis: Boolean

Skips analyzing code bodies, if possible.

Functions

annotationProcessor

abstract fun annotationProcessor(fqName: String)

Adds annotation processor with the specified fqName to the list of processors to run.

annotationProcessors

abstract fun annotationProcessors(vararg fqName: String)

Adds annotation processors with the specified fqName to the list of processors to run.

arguments

abstract fun arguments(action: KaptArguments.() -> Unit)

Configure KaptArguments used for annotation processing.

open fun arguments(action: Action<KaptArguments>)

Configures the KaptArguments used for annotation processing.

getJavacOptions

abstract fun getJavacOptions(): Map<String, String>

Gets all the javac options used to run kapt annotation processing.

javacOptions

abstract fun javacOptions(action: KaptJavacOption.() -> Unit)

open fun javacOptions(action: Action<KaptJavacOption>)

Configures the KaptJavacOption used for annotation processing.