From 9bb6af7211b1ed9d8215831bfb324a23147e8e86 Mon Sep 17 00:00:00 2001 From: Karlatemp Date: Thu, 20 Jul 2023 17:00:54 +0800 Subject: [PATCH] kdocs; keep old internal constructor --- .../compatibility-validation/jvm/api/jvm.api | 1 + .../mirai-console/src/plugin/jvm/AbstractJvmPlugin.kt | 1 + .../mirai-console/src/plugin/jvm/JavaPlugin.kt | 10 ++++++++++ .../mirai-console/src/plugin/jvm/KotlinPlugin.kt | 11 +++++++++++ 4 files changed, 23 insertions(+) diff --git a/mirai-console/backend/mirai-console/compatibility-validation/jvm/api/jvm.api b/mirai-console/backend/mirai-console/compatibility-validation/jvm/api/jvm.api index 329b0d68b2..007a4a52a3 100644 --- a/mirai-console/backend/mirai-console/compatibility-validation/jvm/api/jvm.api +++ b/mirai-console/backend/mirai-console/compatibility-validation/jvm/api/jvm.api @@ -1958,6 +1958,7 @@ public final class net/mamoe/mirai/console/plugin/description/PluginDescription$ } public abstract class net/mamoe/mirai/console/plugin/jvm/AbstractJvmPlugin : net/mamoe/mirai/console/internal/plugin/JvmPluginInternal, net/mamoe/mirai/console/data/AutoSavePluginDataHolder, net/mamoe/mirai/console/plugin/jvm/JvmPlugin { + public fun ()V public fun (Lkotlin/coroutines/CoroutineContext;)V public synthetic fun (Lkotlin/coroutines/CoroutineContext;ILkotlin/jvm/internal/DefaultConstructorMarker;)V public fun (Lnet/mamoe/mirai/console/plugin/jvm/JvmPluginDescription;)V diff --git a/mirai-console/backend/mirai-console/src/plugin/jvm/AbstractJvmPlugin.kt b/mirai-console/backend/mirai-console/src/plugin/jvm/AbstractJvmPlugin.kt index c86a55c1d6..efd83c5fbc 100644 --- a/mirai-console/backend/mirai-console/src/plugin/jvm/AbstractJvmPlugin.kt +++ b/mirai-console/backend/mirai-console/src/plugin/jvm/AbstractJvmPlugin.kt @@ -43,6 +43,7 @@ public abstract class AbstractJvmPlugin : JvmPluginInternal, JvmPlugin, AutoSave this.description = description } + @JvmOverloads public constructor(parentCoroutineContext: CoroutineContext = EmptyCoroutineContext) : super(parentCoroutineContext) { this.description = javaClass.loadPluginDescriptionFromClassLoader() } diff --git a/mirai-console/backend/mirai-console/src/plugin/jvm/JavaPlugin.kt b/mirai-console/backend/mirai-console/src/plugin/jvm/JavaPlugin.kt index 59dcd1e225..8bb19cf18a 100644 --- a/mirai-console/backend/mirai-console/src/plugin/jvm/JavaPlugin.kt +++ b/mirai-console/backend/mirai-console/src/plugin/jvm/JavaPlugin.kt @@ -19,12 +19,22 @@ import kotlin.coroutines.EmptyCoroutineContext */ public abstract class JavaPlugin : JvmPlugin, AbstractJvmPlugin { + /** + * 通过一个指定的 [JvmPluginDescription] 构造插件示例 + * + * 当使用 `plugin.yml` 加载插件示例时不能使用此构造器 + */ @JvmOverloads public constructor( description: JvmPluginDescription, parentCoroutineContext: CoroutineContext = EmptyCoroutineContext, ) : super(description, parentCoroutineContext) + /** + * 通过插件内置的 `plugin.yml` 构造插件实例 + * + * @since 2.16.0 + */ @JvmOverloads public constructor( parentCoroutineContext: CoroutineContext = EmptyCoroutineContext, diff --git a/mirai-console/backend/mirai-console/src/plugin/jvm/KotlinPlugin.kt b/mirai-console/backend/mirai-console/src/plugin/jvm/KotlinPlugin.kt index 888bf8febc..546a22b990 100644 --- a/mirai-console/backend/mirai-console/src/plugin/jvm/KotlinPlugin.kt +++ b/mirai-console/backend/mirai-console/src/plugin/jvm/KotlinPlugin.kt @@ -18,12 +18,23 @@ import kotlin.coroutines.EmptyCoroutineContext * Kotlin 插件的父类. */ public abstract class KotlinPlugin : JvmPlugin, AbstractJvmPlugin { + /** + * 通过一个指定的 [JvmPluginDescription] 构造插件示例 + * + * 当使用 `plugin.yml` 加载插件示例时不能使用此构造器 + */ @JvmOverloads public constructor( description: JvmPluginDescription, parentCoroutineContext: CoroutineContext = EmptyCoroutineContext, ) : super(description, parentCoroutineContext) + + /** + * 通过插件内置的 `plugin.yml` 构造插件实例 + * + * @since 2.16.0 + */ @JvmOverloads public constructor( parentCoroutineContext: CoroutineContext = EmptyCoroutineContext,