From dc9c34982676d5778be62aa9ef0ee9180f588116 Mon Sep 17 00:00:00 2001
From: LamGC <lam827@lamgc.net>
Date: Sun, 15 Aug 2021 14:04:36 +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 做准备.
---
 .../sentry/oci/compute/ssh/SshSession.java     | 18 ++++++++++++++++--
 1 file changed, 16 insertions(+), 2 deletions(-)

diff --git a/src/main/java/net/lamgc/oracle/sentry/oci/compute/ssh/SshSession.java b/src/main/java/net/lamgc/oracle/sentry/oci/compute/ssh/SshSession.java
index 961af4a..2129c23 100644
--- a/src/main/java/net/lamgc/oracle/sentry/oci/compute/ssh/SshSession.java
+++ b/src/main/java/net/lamgc/oracle/sentry/oci/compute/ssh/SshSession.java
@@ -1,12 +1,15 @@
 package net.lamgc.oracle.sentry.oci.compute.ssh;
 
 import org.apache.sshd.client.session.ClientSession;
-import org.apache.sshd.sftp.client.SftpClient;
-import org.apache.sshd.sftp.client.SftpClientFactory;
 
 import java.io.Closeable;
 import java.io.IOException;
 
+/**
+ * SSH 连接会话.
+ * <p> 可与服务器创建多个 SSH 连接会话.
+ * @author LamGC
+ */
 @SuppressWarnings("unused")
 public class SshSession implements Closeable {
 
@@ -16,10 +19,21 @@ public class SshSession implements Closeable {
         this.clientSession = clientSession;
     }
 
+    /**
+     * 创建命令执行会话.
+     * @param command 待执行的命令.
+     * @return 返回命令执行会话.
+     * @throws IOException 当会话创建失败时抛出异常.
+     */
     public CommandExecSession createExecSession(String command) throws IOException {
         return new CommandExecSession(clientSession.createExecChannel(command));
     }
 
+    /**
+     * 关闭 SSH 连接会话, 该连接会话所属的其他会话将会一同被关闭.
+     * @throws IOException 关闭失败时抛出异常,
+     *          可能是由于连接已经被关闭而引起(具体看异常信息).
+     */
     @Override
     public void close() throws IOException {
         clientSession.close();