Add SinceMirai and MiraiExperimentalAPI annotations

This commit is contained in:
Him188 2019-11-16 18:45:40 +08:00
parent 6844b108c0
commit c3603832b0

View File

@ -1,18 +1,31 @@
package net.mamoe.mirai.utils
import kotlin.annotation.AnnotationTarget.*
/**
* 标记这个类, 类型, 函数, 属性, 字段, 或构造器为一个仅供 Mirai 内部使用的 API.
* 标记为一个仅供 Mirai 内部使用的 API.
*
* 这些 API 可能会在任意时刻更改, 且不会发布任何预警.
* 我们非常不建议使用这些 API.
* 非常不建议在发行版本中使用这些 API.
*/
@Experimental(level = Experimental.Level.ERROR)
@Target(
AnnotationTarget.CLASS,
AnnotationTarget.TYPEALIAS,
AnnotationTarget.FUNCTION,
AnnotationTarget.PROPERTY,
AnnotationTarget.FIELD,
AnnotationTarget.CONSTRUCTOR
)
annotation class InternalAPI
@Target(CLASS, TYPEALIAS, FUNCTION, PROPERTY, FIELD, CONSTRUCTOR)
internal annotation class MiraiInternalAPI
/**
* 标记这个类, 类型, 函数, 属性, 字段, 或构造器为实验性的.
*
* 这些 API 不具有稳定性, 且可能会在任意时刻更改.
* 不建议在发行版本中使用这些 API.
*/
@Experimental(level = Experimental.Level.ERROR)
@Target(CLASS, TYPEALIAS, FUNCTION, PROPERTY, FIELD, CONSTRUCTOR)
internal annotation class MiraiExperimentalAPI
/**
* 标记这个 API 是自 Mirai 某个版本起才受支持.
*/
@Target(CLASS, PROPERTY, FIELD, CONSTRUCTOR, FUNCTION, PROPERTY_GETTER, PROPERTY_SETTER, TYPEALIAS)
@Retention(AnnotationRetention.BINARY)
@MustBeDocumented
internal annotation class SinceMirai(val version: String)