kotlin-utils/org.modelix.kotlin.utils/DeprecationInfo

DeprecationInfo

@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.FUNCTION, AnnotationTarget.PROPERTY, AnnotationTarget.ANNOTATION_CLASS, AnnotationTarget.CONSTRUCTOR, AnnotationTarget.PROPERTY_SETTER, AnnotationTarget.PROPERTY_GETTER, AnnotationTarget.TYPEALIAS])
annotation class DeprecationInfo(val since: String, val removalHint: String = "")

Stores information on Deprecated code. This information is intended to facilitate performing the deprecation cycle.

Properties

Link copied to clipboard
val removalHint: String

an optional hint on when it is ok to remove the deprecated code. For instance, this property can include known uses of the deprecated construct that have to be checked before removing the deprecated code.

Link copied to clipboard
val since: String

an information since when the construct is deprecated. Preferably, use an ISO 8601 data such as 2022-01-09