From 29012d74c1497763b7067113d7b44300d8e22f5c Mon Sep 17 00:00:00 2001
From: Him188 <Him188@mamoe.net>
Date: Mon, 11 May 2020 15:50:18 +0800
Subject: [PATCH] Add docs

---
 .../kotlin/net.mamoe.mirai/utils/MiraiLogger.kt |  2 ++
 .../kotlin/net/mamoe/mirai/BotFactory.kt        | 11 ++++++++---
 .../kotlin/net/mamoe/mirai/BotFactoryJvm.kt     | 17 -----------------
 3 files changed, 10 insertions(+), 20 deletions(-)
 delete mode 100644 mirai-core/src/jvmMain/kotlin/net/mamoe/mirai/BotFactoryJvm.kt

diff --git a/mirai-core/src/commonMain/kotlin/net.mamoe.mirai/utils/MiraiLogger.kt b/mirai-core/src/commonMain/kotlin/net.mamoe.mirai/utils/MiraiLogger.kt
index 19303e301..82c19fec2 100644
--- a/mirai-core/src/commonMain/kotlin/net.mamoe.mirai/utils/MiraiLogger.kt
+++ b/mirai-core/src/commonMain/kotlin/net.mamoe.mirai/utils/MiraiLogger.kt
@@ -28,6 +28,8 @@ import kotlin.jvm.JvmOverloads
  * **注意:** 请为日志做好分类, 即不同的模块使用不同的 [MiraiLogger].
  * 如, [Bot] 中使用 identity 为 "Bot(qqId)" 的 [MiraiLogger]
  * 而 [Bot] 的网络处理中使用 identity 为 "BotNetworkHandler" 的.
+ *
+ * Java 调用: `Utils.getDefaultLogger().invoke(identity)`
  */
 var DefaultLogger: (identity: String?) -> MiraiLogger = { PlatformLogger(it) }
 
diff --git a/mirai-core/src/jvmMain/kotlin/net/mamoe/mirai/BotFactory.kt b/mirai-core/src/jvmMain/kotlin/net/mamoe/mirai/BotFactory.kt
index 0bb569206..cb9d4c579 100644
--- a/mirai-core/src/jvmMain/kotlin/net/mamoe/mirai/BotFactory.kt
+++ b/mirai-core/src/jvmMain/kotlin/net/mamoe/mirai/BotFactory.kt
@@ -47,6 +47,8 @@ actual interface BotFactory {
 
 /**
  * 自动加载现有协议的 [BotFactory], 并使用指定的 [配置][configuration] 构造 [Bot] 实例
+ *
+ * Java 调用方式: `BotFactoryJvm.newBot(...)`
  */
 @JvmName("newBot")
 @JvmOverloads
@@ -63,6 +65,8 @@ inline fun Bot(context: Context, qq: Long, password: String, configuration: (Bot
 
 /**
  * 自动加载现有协议的 [BotFactory], 并使用指定的 [配置][configuration] 构造 [Bot] 实例
+ *
+ * Java 调用方式: `BotFactoryJvm.newBot(...)`
  */
 @JvmName("newBot")
 @JvmOverloads
@@ -79,6 +83,8 @@ inline fun Bot(qq: Long, password: String, configuration: (BotConfiguration.() -
 
 /**
  * 自动加载现有协议的 [BotFactory], 并使用指定的 [配置][configuration] 构造 [Bot] 实例
+ *
+ * Java 调用方式: `BotFactoryJvm.newBot(...)`
  */
 @JvmName("newBot")
 @JvmOverloads
@@ -100,6 +106,8 @@ inline fun Bot(context: Context, qq: Long, passwordMd5: ByteArray, configuration
 
 /**
  * 自动加载现有协议的 [BotFactory], 并使用指定的 [配置][configuration] 构造 [Bot] 实例
+ *
+ * Java 调用方式: `BotFactoryJvm.newBot(...)`
  */
 @JvmName("newBot")
 @JvmOverloads
@@ -114,9 +122,6 @@ inline fun Bot(qq: Long, passwordMd5: ByteArray, configuration: (BotConfiguratio
     factory.Bot(ContextImpl(), qq, passwordMd5, BotConfiguration().apply(configuration))
 
 
-
-
-
 // Do not use ServiceLoader. Probably not working on MPP
 @PublishedApi
 internal val factory: BotFactory = run {
diff --git a/mirai-core/src/jvmMain/kotlin/net/mamoe/mirai/BotFactoryJvm.kt b/mirai-core/src/jvmMain/kotlin/net/mamoe/mirai/BotFactoryJvm.kt
deleted file mode 100644
index 726ca00f2..000000000
--- a/mirai-core/src/jvmMain/kotlin/net/mamoe/mirai/BotFactoryJvm.kt
+++ /dev/null
@@ -1,17 +0,0 @@
-/*
- * Copyright 2020 Mamoe Technologies and contributors.
- *
- * 此源代码的使用受 GNU AFFERO GENERAL PUBLIC LICENSE version 3 许可证的约束, 可以在以下链接找到该许可证.
- * Use of this source code is governed by the GNU AGPLv3 license that can be found through the following link.
- *
- * https://github.com/mamoe/mirai/blob/master/LICENSE
- */
-
-@file:JvmName("BotFactoryJvm")
-@file:Suppress("FunctionName", "unused")
-
-package net.mamoe.mirai
-
-import net.mamoe.mirai.utils.BotConfiguration
-import net.mamoe.mirai.utils.Context
-import net.mamoe.mirai.utils.ContextImpl