annotatedBy

abstract fun annotatedBy(vararg annotationName: String)(source)

Add to filters all classes and functions marked by specified annotations.

Use cases:

  • in case of exclusion filters all classes or function marked by at least one of the specified annotation will be excluded from the report

  • in case of inclusion filters only classes marked by at least one of the specified annotations will be included in the report

It is acceptable to use * and ? wildcards, * means any number of arbitrary characters (including no chars), ? means one arbitrary character.

Does not work for JaCoCo

Example:

annotatedBy("*Generated*", "com.example.KoverExclude")

abstract fun annotatedBy(vararg annotationName: Provider<String>)(source)

Add to filters all classes and functions marked by specified annotations.

Use cases:

  • in case of exclusion filters all classes or function marked by at least one of the specified annotation will be excluded from the report

  • in case of inclusion filters only classes marked by at least one of the specified annotations will be included in the report

Used for lazy setup.

It is acceptable to use * and ? wildcards, * means any number of arbitrary characters (including no chars), ? means one arbitrary character.

Does not work for JaCoCo

Example:

val annotation: Provider<String> = ...
annotatedBy(annotation)

abstract val annotatedBy: SetProperty<String>(source)

Filters for classes and functions marked by specified annotations.

Use cases:

  • in case of exclusion filters all classes or function marked by at least one of the specified annotation will be excluded from the report

  • in case of inclusion filters only classes marked by at least one of the specified annotations will be included in the report

It is acceptable to use * and ? wildcards, * means any number of arbitrary characters (including no chars), ? means one arbitrary character.

Does not work for JaCoCo

Example:

annotatedBy.addAll("*Generated*", "com.example.KoverExclude")