ApiValidationExtension

Constructors

Link copied to clipboard
constructor()

Properties

Link copied to clipboard

Non-default Gradle SourceSet names that should be validated. By default, only the main source set is checked.

Link copied to clipboard

A path to a directory containing an API dump. The path should be relative to the project's root directory and should resolve to its subdirectory. By default, it's api.

Link copied to clipboard

Fully qualified names of classes that are ignored by the API check. Example of such a class could be com.package.android.BuildConfig.

Link copied to clipboard

Fully qualified package names that are not consider public API. For example, it could be kotlinx.coroutines.internal or kotlinx.serialization.implementation.

Link copied to clipboard

Projects that are ignored by the API check.

Link copied to clipboard

KLib ABI validation settings.

Link copied to clipboard

Fully qualified names of annotations that effectively exclude declarations from being public. Example of such annotation could be kotlinx.coroutines.InternalCoroutinesApi.

Link copied to clipboard

Fully qualified names of public classes. If at least one of publicMarkers, publicPackages or publicClasses is defined, all declarations not covered by any of them will be considered non-public. ignoredPackages, ignoredClasses and nonPublicMarkers can be used for additional filtering.

Link copied to clipboard

Fully qualified names of annotations that can be used to explicitly mark public declarations. If at least one of publicMarkers, publicPackages or publicClasses is defined, all declarations not covered by any of them will be considered non-public. ignoredPackages, ignoredClasses and nonPublicMarkers can be used for additional filtering.

Link copied to clipboard

Fully qualified package names that contain public declarations. If at least one of publicMarkers, publicPackages or publicClasses is defined, all declarations not covered by any of them will be considered non-public. ignoredPackages, ignoredClasses and nonPublicMarkers can be used for additional filtering.

Link copied to clipboard

Disables API validation checks completely.

Functions

Link copied to clipboard
fun klib(block: KlibValidationSettings.() -> Unit)

Configure KLib ABI validation settings.