equinox-core/com.tecknobit.equinoxcore.annotations/FutureEquinoxApi

FutureEquinoxApi

@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.ANNOTATION_CLASS, AnnotationTarget.TYPE_PARAMETER, AnnotationTarget.PROPERTY, AnnotationTarget.FIELD, AnnotationTarget.LOCAL_VARIABLE, AnnotationTarget.VALUE_PARAMETER, AnnotationTarget.CONSTRUCTOR, AnnotationTarget.FUNCTION, AnnotationTarget.PROPERTY_GETTER, AnnotationTarget.PROPERTY_SETTER, AnnotationTarget.TYPE, AnnotationTarget.EXPRESSION, AnnotationTarget.FILE, AnnotationTarget.TYPEALIAS])

annotation class FutureEquinoxApi(val protoBehavior: String = "", val releaseVersion: String = "", val additionalNotes: String = "")

The FutureEquinoxApi annotation is useful to indicate an experimental api implemented in an external project outside Equinox that can be potentially implemented in the official library

Usage Example:

@FutureEquinoxApi(
    protoBehavior = """
        At the moment the proto api behaves etc...
    """ // text block suggested,
    releaseVersion = "1.0.9",
    additionalNotes = """
        - More customization
        - Add more styles
        - ...
    """ // text block suggested
)
class PotentialApi {
     ... behavior
}

Author

N7ghtm4r3 - Tecknobit

Since

1.0.8

Properties

additionalNotes

val additionalNotes: String

Additional notes about some improvements or any requirements to implement in the official api

protoBehavior

val protoBehavior: String

The prototypical behavior the api currently has before the official integration

releaseVersion

val releaseVersion: String

The version of the release candidate to implement this api