From eda0e522cdf778a9039bfe4b957964e1c5164ec9 Mon Sep 17 00:00:00 2001
From: LamGC <lam827@lamgc.net>
Date: Fri, 22 Jul 2022 21:59:14 +0800
Subject: [PATCH] =?UTF-8?q?docs(config):=20=E8=A1=A5=E5=85=85=E5=85=B3?=
 =?UTF-8?q?=E4=BA=8E=20Gson=20=E7=B1=BB=E5=9E=8B=E9=80=82=E9=85=8D?=
 =?UTF-8?q?=E5=99=A8=E7=9A=84=E4=BD=BF=E7=94=A8=E6=8C=87=E5=AF=BC.?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

为 AppConfig 和 BotConfig 补充关于 Gson 类型适配器使用的信息, 以便于开发者正确使用类型适配器解析和编码 Json.
---
 scalabot-meta/src/main/kotlin/Configs.kt | 14 ++++++++++++++
 1 file changed, 14 insertions(+)

diff --git a/scalabot-meta/src/main/kotlin/Configs.kt b/scalabot-meta/src/main/kotlin/Configs.kt
index 949b5f0..9fb078b 100644
--- a/scalabot-meta/src/main/kotlin/Configs.kt
+++ b/scalabot-meta/src/main/kotlin/Configs.kt
@@ -28,6 +28,13 @@ data class BotAccount(
 
 /**
  * 机器人配置.
+ *
+ * 使用 Gson 解析时, 请添加以下类型适配器:
+ * - [net.lamgc.scalabot.config.serializer.ProxyTypeSerializer]
+ * - [net.lamgc.scalabot.config.serializer.BotConfigSerializer]
+ * - [net.lamgc.scalabot.config.serializer.BotAccountSerializer]
+ * - [net.lamgc.scalabot.config.serializer.ArtifactSerializer]
+ *
  * @property enabled 是否启用机器人.
  * @property account 机器人帐号信息, 用于访问 API.
  * @property disableBuiltInAbility 是否禁用 AbilityBot 自带命令.
@@ -126,6 +133,13 @@ data class MavenRepositoryConfig(
  * ScalaBot App 配置.
  *
  * App 配置信息与 BotConfig 分开, 分别存储在各自单独的文件中.
+ *
+ * 使用 Gson 解析时, 请添加以下类型适配器:
+ * - [net.lamgc.scalabot.config.serializer.ProxyTypeSerializer]
+ * - [net.lamgc.scalabot.config.serializer.MavenRepositoryConfigSerializer]
+ * - [net.lamgc.scalabot.config.serializer.AuthenticationSerializer]
+ * - [net.lamgc.scalabot.config.serializer.UsernameAuthenticatorSerializer]
+ *
  * @property proxy Telegram API 代理配置.
  * @property metrics 运行指标数据配置. 可通过时序数据库记录运行数据.
  * @property mavenRepositories Maven 远端仓库配置.