Package-level declarations

Types

Link copied to clipboard

Why an exemption annotation is applied.

Link copied to clipboard
annotation class IntentionallyBooleanParameter(val description: String = "", val reason: ExemptionReason = ExemptionReason.OTHER)

Exempts the annotated function or parameter from Boolean parameters in public API.

Link copied to clipboard
@Target(allowedTargets = [AnnotationTarget.CLASS])
annotation class IntentionallyDataClass(val description: String = "", val reason: ExemptionReason = ExemptionReason.OTHER)

Exempts the annotated data class from Data classes in public API.

Link copied to clipboard
@Target(allowedTargets = [AnnotationTarget.FILE])
annotation class IntentionallyDefaultFacadeName(val description: String = "", val reason: ExemptionReason = ExemptionReason.OTHER)

Exempts the annotated file from Top-level API without JvmName.

Link copied to clipboard
@Target(allowedTargets = [AnnotationTarget.CLASS])
annotation class IntentionallyExhaustive(val description: String = "", val reason: ExemptionReason = ExemptionReason.OTHER)

Exempts the annotated enum or sealed hierarchy from Exhaustive public API.

Exempts the annotated declaration, parameter, or type usage from Public types marked as internal API. On a class, it covers the supertypes and the type parameter bounds, not the members.

Link copied to clipboard
@Target(allowedTargets = [AnnotationTarget.TYPEALIAS])
annotation class IntentionallyFunctionTypeAlias(val description: String = "", val reason: ExemptionReason = ExemptionReason.OTHER)

Exempts the annotated type alias from Function type aliases in public API.

Link copied to clipboard
annotation class IntentionallyInconsistentParameterOrder(val description: String = "", val reason: ExemptionReason = ExemptionReason.OTHER)

Exempts the annotated function or constructor from Inconsistent parameter order in overloads.

Link copied to clipboard
annotation class IntentionallyInlinedLogic(val description: String = "", val reason: ExemptionReason = ExemptionReason.OTHER)

Exempts the annotated inline function, or the inline accessors of the annotated property, from Inline functions with logic.

Link copied to clipboard
annotation class IntentionallyKotlinOnlyApi(val description: String = "", val reason: ExemptionReason = ExemptionReason.OTHER)

Exempts the annotated function from Kotlin-only API without JvmSynthetic. On a class, it covers every function in the class.

Link copied to clipboard

Exempts the annotated declaration from Mangled JVM names in public API. On a class, it covers every nested declaration.

Link copied to clipboard

Exempts the annotated declaration, parameter, or type usage from Mutable collections in public API.

Link copied to clipboard
annotation class IntentionallyNonStaticCompanionApi(val description: String = "", val reason: ExemptionReason = ExemptionReason.OTHER)

Exempts the annotated companion object member from Companion function without JvmStatic and Companion property without static access. On a companion object or a class, it covers every member.

Link copied to clipboard

Exempts the annotated declaration, parameter, or type usage from Public types from non-transitive dependencies. On a class, it covers every nested declaration.

Link copied to clipboard

Exempts the annotated declaration, parameter, or type usage from Nullable Booleans in public API.

Link copied to clipboard
annotation class IntentionallyOpen(val description: String = "", val reason: ExemptionReason = ExemptionReason.OTHER)

Exempts the annotated class, interface, or actual typealias from Open API without subclass opt-in.

Link copied to clipboard

Exempts the annotated declaration, parameter, or type usage from Pair and Triple in public API.

annotation class IntentionallyRequiredParameterAfterOptional(val description: String = "", val reason: ExemptionReason = ExemptionReason.OTHER)

Exempts the annotated function or constructor from Required parameters after optional ones.

Link copied to clipboard

Exempts the annotated declaration from Undocumented public API.

Link copied to clipboard
@Target(allowedTargets = [AnnotationTarget.CLASS])
annotation class IntentionallyWithoutEquals(val description: String = "", val reason: ExemptionReason = ExemptionReason.OTHER)

Exempts the annotated class from STATEFUL_CLASS_WITHOUT_EQUALS, one of the checks of Stateful classes without equals, hashCode, and toString.

@Target(allowedTargets = [AnnotationTarget.CLASS])
annotation class IntentionallyWithoutEqualsHashCodeOrToString(val description: String = "", val reason: ExemptionReason = ExemptionReason.OTHER)

Exempts the annotated class from all three checks of Stateful classes without equals, hashCode, and toString.

Link copied to clipboard
@Target(allowedTargets = [AnnotationTarget.CLASS])
annotation class IntentionallyWithoutHashCode(val description: String = "", val reason: ExemptionReason = ExemptionReason.OTHER)

Exempts the annotated class from STATEFUL_CLASS_WITHOUT_HASH_CODE, one of the checks of Stateful classes without equals, hashCode, and toString.

Link copied to clipboard
annotation class IntentionallyWithoutJvmOverloads(val description: String = "", val reason: ExemptionReason = ExemptionReason.OTHER)

Exempts the annotated function or constructor from Default parameters without JvmOverloads.

Link copied to clipboard
@Target(allowedTargets = [AnnotationTarget.CLASS])
annotation class IntentionallyWithoutToString(val description: String = "", val reason: ExemptionReason = ExemptionReason.OTHER)

Exempts the annotated class from STATEFUL_CLASS_WITHOUT_TO_STRING, one of the checks of Stateful classes without equals, hashCode, and toString.

Link copied to clipboard

Makes the annotated annotation class an internal API marker. Declarations annotated with the marked annotation, and everything nested in them, are exempt from the public API checks. EXEMPTION_WITHOUT_EXPLANATION and the DSL marker checks still apply to them. The marked annotation class itself is still checked.