From 084e18c204184b55709ab424eb4ac6025ca277a6 Mon Sep 17 00:00:00 2001 From: Him188 Date: Mon, 28 Dec 2020 19:20:49 +0800 Subject: [PATCH] Update docs --- mirai-core-api/src/commonMain/kotlin/contact/Contact.kt | 2 +- mirai-core-api/src/commonMain/kotlin/contact/Friend.kt | 2 +- mirai-core-api/src/commonMain/kotlin/contact/Member.kt | 5 +++-- mirai-core-api/src/commonMain/kotlin/contact/User.kt | 3 +-- 4 files changed, 6 insertions(+), 6 deletions(-) diff --git a/mirai-core-api/src/commonMain/kotlin/contact/Contact.kt b/mirai-core-api/src/commonMain/kotlin/contact/Contact.kt index f351f0d6c..4eec54777 100644 --- a/mirai-core-api/src/commonMain/kotlin/contact/Contact.kt +++ b/mirai-core-api/src/commonMain/kotlin/contact/Contact.kt @@ -55,7 +55,7 @@ public interface Contact : ContactOrBot, CoroutineScope { * @throws MessageTooLargeException 当消息过长时抛出 * @throws IllegalArgumentException 当消息内容为空时抛出 (详见 [Message.isContentEmpty]) * - * @return 消息回执. 可 [引用回复][MessageReceipt.quote]（仅群聊）或 [撤回][MessageReceipt.recall] 这条消息. + * @return 消息回执. 可 [引用][MessageReceipt.quote] 或 [撤回][MessageReceipt.recall] 这条消息. */ @JvmBlockingBridge public suspend fun sendMessage(message: Message): MessageReceipt diff --git a/mirai-core-api/src/commonMain/kotlin/contact/Friend.kt b/mirai-core-api/src/commonMain/kotlin/contact/Friend.kt index eb2153bfa..88ad69542 100644 --- a/mirai-core-api/src/commonMain/kotlin/contact/Friend.kt +++ b/mirai-core-api/src/commonMain/kotlin/contact/Friend.kt @@ -61,7 +61,7 @@ public interface Friend : User, CoroutineScope { * @throws MessageTooLargeException 当消息过长时抛出 * @throws IllegalArgumentException 当消息内容为空时抛出 (详见 [Message.isContentEmpty]) * - * @return 消息回执. 可进行撤回 ([MessageReceipt.recall]) + * @return 消息回执. 可 [引用][MessageReceipt.quote] 或 [撤回][MessageReceipt.recall] 这条消息. */ @JvmBlockingBridge public override suspend fun sendMessage(message: Message): MessageReceipt diff --git a/mirai-core-api/src/commonMain/kotlin/contact/Member.kt b/mirai-core-api/src/commonMain/kotlin/contact/Member.kt index 2bd073948..52373014f 100644 --- a/mirai-core-api/src/commonMain/kotlin/contact/Member.kt +++ b/mirai-core-api/src/commonMain/kotlin/contact/Member.kt @@ -91,7 +91,7 @@ public interface Member : User { * * 单条消息最大可发送 4500 字符或 50 张图片. * - * 注意: 只可以向 [NormalMember] 发送消息. 向 [AnonymousMember] 发送时将会得到异常. + * 注意: 只可以向 [NormalMember] 发送消息. 向 [AnonymousMember] 发送时将会得到异常 [UnsupportedOperationException]. * * @see FriendMessagePreSendEvent 当此成员是好友时发送消息前事件 * @see FriendMessagePostSendEvent 当此成员是好友时发送消息后事件 @@ -103,8 +103,9 @@ public interface Member : User { * @throws BotIsBeingMutedException 发送群消息时若 [Bot] 被禁言抛出 * @throws MessageTooLargeException 当消息过长时抛出 * @throws IllegalArgumentException 当消息内容为空时抛出 (详见 [Message.isContentEmpty]) + * @throws UnsupportedOperationException 当向 [AnonymousMember] 发送消息时抛出 * - * @return 消息回执. 可进行撤回 ([MessageReceipt.recall]) + * @return 消息回执. 可 [引用][MessageReceipt.quote] 或 [撤回][MessageReceipt.recall] 这条消息. */ public override suspend fun sendMessage(message: Message): MessageReceipt diff --git a/mirai-core-api/src/commonMain/kotlin/contact/User.kt b/mirai-core-api/src/commonMain/kotlin/contact/User.kt index 4b46007fb..4b5d855b0 100644 --- a/mirai-core-api/src/commonMain/kotlin/contact/User.kt +++ b/mirai-core-api/src/commonMain/kotlin/contact/User.kt @@ -66,11 +66,10 @@ public interface User : Contact, UserOrBot, CoroutineScope { * @see UserMessagePostSendEvent 发送消息后事件 * * @throws EventCancelledException 当发送消息事件被取消时抛出 - * @throws BotIsBeingMutedException 发送群消息时若 [Bot] 被禁言抛出 * @throws MessageTooLargeException 当消息过长时抛出 * @throws IllegalArgumentException 当消息内容为空时抛出 (详见 [Message.isContentEmpty]) * - * @return 消息回执. 可进行撤回 ([MessageReceipt.recall]) + * @return 消息回执. 可 [引用][MessageReceipt.quote] 或 [撤回][MessageReceipt.recall] 这条消息. */ @JvmBlockingBridge public override suspend fun sendMessage(message: Message): MessageReceipt