Commit 29012d74 authored by Him188's avatar Him188

Add docs

parent aa126840
......@@ -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) }
......
......@@ -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 {
......
/*
* 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
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment