From b4f60582fd6c5b850e4bfda11f626ab99f427ecb Mon Sep 17 00:00:00 2001
From: Him188 <Him188@mamoe.net>
Date: Fri, 8 Jan 2021 09:12:36 +0800
Subject: [PATCH] Update docs

---
 .../src/commonMain/kotlin/message/action/Nudge.kt         | 8 +++++---
 .../src/commonMain/kotlin/utils/BotConfiguration.kt       | 2 +-
 2 files changed, 6 insertions(+), 4 deletions(-)

diff --git a/mirai-core-api/src/commonMain/kotlin/message/action/Nudge.kt b/mirai-core-api/src/commonMain/kotlin/message/action/Nudge.kt
index 23c5e6689..f335824b9 100644
--- a/mirai-core-api/src/commonMain/kotlin/message/action/Nudge.kt
+++ b/mirai-core-api/src/commonMain/kotlin/message/action/Nudge.kt
@@ -22,8 +22,10 @@ import net.mamoe.mirai.utils.BotConfiguration.MiraiProtocol
  *
  * 仅在手机 QQ 8.4.0 左右版本才受支持. 其他客户端会忽略这些消息.
  *
- * @see User.nudge 创建 [Nudge] 对象
- * @see Bot.nudge 创建 [Nudge] 对象
+ * 示例，要机器人戳一个群员并发送到群里，使用 `member.nudge().sendTo(group)`.
+ * 要机器人戳一个好友并发送给该好友，使用 `friend.nudge().sendTo(friend)`.
+ *
+ * @see UserOrBot.nudge 创建 [Nudge] 对象
  */
 public sealed class Nudge {
     /**
@@ -32,7 +34,7 @@ public sealed class Nudge {
     public abstract val target: UserOrBot
 
     /**
-     * 发送戳一戳该成员的消息.
+     * 发送戳一戳该成员的消息到 [receiver].
      *
      * 需要 [使用协议][BotConfiguration.protocol] [MiraiProtocol.ANDROID_PHONE].
      *
diff --git a/mirai-core-api/src/commonMain/kotlin/utils/BotConfiguration.kt b/mirai-core-api/src/commonMain/kotlin/utils/BotConfiguration.kt
index 41add713a..1eec11725 100644
--- a/mirai-core-api/src/commonMain/kotlin/utils/BotConfiguration.kt
+++ b/mirai-core-api/src/commonMain/kotlin/utils/BotConfiguration.kt
@@ -115,7 +115,7 @@ public open class BotConfiguration { // open for Java
      * @see fileBasedDeviceInfo 使用指定文件存储设备信息
      * @see randomDeviceInfo 使用随机设备信息
      */
-    public var deviceInfo: ((Bot) -> DeviceInfo)? = deviceInfoStub
+    public var deviceInfo: ((Bot) -> DeviceInfo)? = deviceInfoStub // allows user to set `null` manually.
 
     /**
      * Json 序列化器, 使用 'kotlinx.serialization'