From 05429e5800b969dbe3ba574412e6878817d8eb9f Mon Sep 17 00:00:00 2001
From: Him188 <Him188@mamoe.net>
Date: Wed, 6 May 2020 11:33:58 +0800
Subject: [PATCH] Add docs
---
.../kotlin/net.mamoe.mirai/event/Event.kt | 17 ++++++++++++++++-
1 file changed, 16 insertions(+), 1 deletion(-)
diff --git a/mirai-core/src/commonMain/kotlin/net.mamoe.mirai/event/Event.kt b/mirai-core/src/commonMain/kotlin/net.mamoe.mirai/event/Event.kt
index edf0706d7..be181ddae 100644
--- a/mirai-core/src/commonMain/kotlin/net.mamoe.mirai/event/Event.kt
+++ b/mirai-core/src/commonMain/kotlin/net.mamoe.mirai/event/Event.kt
@@ -79,15 +79,30 @@ abstract class AbstractEvent : Event {
private val _cancelled = atomic(false)
// 实现 Event
- override val isIntercepted: Boolean get() = _intercepted
+ /**
+ * @see Event.isIntercepted
+ */
+ @SinceMirai("1.0.0")
+ override val isIntercepted: Boolean
+ get() = _intercepted
+ /**
+ * @see Event.intercept
+ */
@SinceMirai("1.0.0")
override fun intercept() {
_intercepted = true
}
// 实现 CancellableEvent
+ /**
+ * @see CancellableEvent.isCancelled
+ */
val isCancelled: Boolean get() = _cancelled.value
+
+ /**
+ * @see CancellableEvent.cancel
+ */
fun cancel() {
check(this is CancellableEvent) {
"Event $this is not cancellable"