From edd823c7bc12bcd9e77c3a9c80d49809c96dd685 Mon Sep 17 00:00:00 2001 From: Him188 Date: Mon, 20 Apr 2020 21:52:07 +0800 Subject: [PATCH] Improve docs --- .../kotlin/net.mamoe.mirai/message/data/At.kt | 2 +- .../net.mamoe.mirai/message/data/CustomMessage.kt | 2 ++ .../kotlin/net.mamoe.mirai/message/data/Message.kt | 14 +++++++++++++- 3 files changed, 16 insertions(+), 2 deletions(-) diff --git a/mirai-core/src/commonMain/kotlin/net.mamoe.mirai/message/data/At.kt b/mirai-core/src/commonMain/kotlin/net.mamoe.mirai/message/data/At.kt index b6ae30bc3..a206d6a4f 100644 --- a/mirai-core/src/commonMain/kotlin/net.mamoe.mirai/message/data/At.kt +++ b/mirai-core/src/commonMain/kotlin/net.mamoe.mirai/message/data/At.kt @@ -25,7 +25,7 @@ import kotlin.jvm.JvmSynthetic /** - * At 一个人. 只能发送给一个群. + * At 一个群成员. 只能发送给一个群. * * @see AtAll 全体成员 */ diff --git a/mirai-core/src/commonMain/kotlin/net.mamoe.mirai/message/data/CustomMessage.kt b/mirai-core/src/commonMain/kotlin/net.mamoe.mirai/message/data/CustomMessage.kt index 3fee9e258..4aae456f3 100644 --- a/mirai-core/src/commonMain/kotlin/net.mamoe.mirai/message/data/CustomMessage.kt +++ b/mirai-core/src/commonMain/kotlin/net.mamoe.mirai/message/data/CustomMessage.kt @@ -31,6 +31,8 @@ import net.mamoe.mirai.utils.* * **实现方法**: * * @sample samples.CustomMessageIdentifier 实现示例 + * + * @see CustomMessageMetadata */ @SinceMirai("0.38.0") @MiraiExperimentalAPI diff --git a/mirai-core/src/commonMain/kotlin/net.mamoe.mirai/message/data/Message.kt b/mirai-core/src/commonMain/kotlin/net.mamoe.mirai/message/data/Message.kt index 85e9ebe92..770750d76 100644 --- a/mirai-core/src/commonMain/kotlin/net.mamoe.mirai/message/data/Message.kt +++ b/mirai-core/src/commonMain/kotlin/net.mamoe.mirai/message/data/Message.kt @@ -17,6 +17,7 @@ import net.mamoe.mirai.utils.MiraiInternalAPI import net.mamoe.mirai.utils.PlannedRemoval import net.mamoe.mirai.utils.SinceMirai import kotlin.jvm.JvmName +import kotlin.jvm.JvmOverloads import kotlin.jvm.JvmSynthetic /** @@ -266,7 +267,10 @@ interface SingleMessage : Message, CharSequence, Comparable { /** * 消息元数据, 即不含内容的元素. - * 包括: [MessageSource] + * + * @see MessageSource 消息源 + * @see QuoteReply 引用回复 + * @see CustomMessageMetadata 自定义元数据 * * @see ConstrainSingle 约束一个 [MessageChain] 中只存在这一种类型的元素 */ @@ -288,6 +292,14 @@ interface ConstrainSingle : MessageMetadata { /** * 消息内容 + * + * @see PlainText 纯文本 + * @see At At 一个群成员. + * @see AtAll At 全体成员 + * @see HummerMessage 一些特殊消息: [戳一戳][PokeMessage], [闪照][FlashImage] + * @see Image 图片 + * @see RichMessage 富文本 + * @see Face 原生表情 */ interface MessageContent : SingleMessage