From da86b0f9bc05923b8b25c7b2f008fbf35f42708f Mon Sep 17 00:00:00 2001
From: LamGC <lam827@lamgc.net>
Date: Sun, 15 Aug 2021 13:36:28 +0800
Subject: [PATCH] =?UTF-8?q?docs:=20=E8=A1=A5=E5=85=85=E6=96=87=E6=A1=A3.?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

补充类文档, 以做好导出 Javadoc 的准备.
---
 .../oracle/sentry/oci/compute/ssh/SshAuthInfoSerializer.java  | 4 ++++
 src/main/java/net/lamgc/oracle/sentry/script/Script.java      | 2 ++
 2 files changed, 6 insertions(+)

diff --git a/src/main/java/net/lamgc/oracle/sentry/oci/compute/ssh/SshAuthInfoSerializer.java b/src/main/java/net/lamgc/oracle/sentry/oci/compute/ssh/SshAuthInfoSerializer.java
index 92309ed..52ad53d 100644
--- a/src/main/java/net/lamgc/oracle/sentry/oci/compute/ssh/SshAuthInfoSerializer.java
+++ b/src/main/java/net/lamgc/oracle/sentry/oci/compute/ssh/SshAuthInfoSerializer.java
@@ -15,6 +15,10 @@ import java.util.Base64;
 import java.util.Collections;
 
 /**
+ * SSH 认证配置编解码类.
+ * <p> 由于实例公共 IP 可能会发生改变, SSH 自带的 known_hosts 信任列表不再适用,
+ * 所以我们采用 InstanceId 代替 IP 来绑定 Server key, 同时保存认证类型和认证信息,
+ * 来安全保存(表面上的) SSH 认证配置.
  * @author LamGC
  */
 public final class SshAuthInfoSerializer implements JsonSerializer<SshAuthInfo>, JsonDeserializer<SshAuthInfo> {
diff --git a/src/main/java/net/lamgc/oracle/sentry/script/Script.java b/src/main/java/net/lamgc/oracle/sentry/script/Script.java
index e1f685e..3abded0 100644
--- a/src/main/java/net/lamgc/oracle/sentry/script/Script.java
+++ b/src/main/java/net/lamgc/oracle/sentry/script/Script.java
@@ -1,6 +1,8 @@
 package net.lamgc.oracle.sentry.script;
 
 /**
+ * 脚本基类.
+ * <p> 实现该接口的可视为脚本, 具体细节由具体脚本语言的模块定义.
  * @author LamGC
  */
 public interface Script {