included

open fun included(action: Action<AbiFilterSetSpec>)
open fun included(action: AbiFilterSetSpec.() -> Unit)

Configures the included variable with the provided configuration.


A set of filtering rules that restrict ABI declarations from being included in a dump.

It consists of a combination of rules for including declarations. Each filter can be written as either a class name filter (see AbiFilterSetSpec.byNames) or an annotation filter (see AbiFilterSetSpec.annotatedWith).

filters {
included {
byNames.add("foo.api.**")
annotatedWith.add("foo.PublicApi")
}
}

In order for a declaration (class, field, property or function) to be included in the dump, it must pass the inclusion filter. A declaration successfully passes the inclusion filter if no inclusion rules exist, if it matches any inclusion rule, or if at least one of its members (relevant for class declaration) matches any inclusion rule.