From ebc96e5176c2a748c6855c18a80fa21c3f82741e Mon Sep 17 00:00:00 2001
From: CarmJos <KarmunJ@outlook.com>
Date: Tue, 14 Dec 2021 20:19:04 +0800
Subject: [PATCH] =?UTF-8?q?[v0.2.1-fix]=20=E8=A1=A5=E5=85=A8=E7=BC=BA?=
 =?UTF-8?q?=E5=A4=B1=E7=9A=84javadoc?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 .../cc/carm/lib/easysql/api/SQLAction.java    |  8 +--
 .../cc/carm/lib/easysql/api/SQLManager.java   | 68 +++++++++++++++++--
 2 files changed, 66 insertions(+), 10 deletions(-)

diff --git a/easysql-api/src/main/java/cc/carm/lib/easysql/api/SQLAction.java b/easysql-api/src/main/java/cc/carm/lib/easysql/api/SQLAction.java
index 64225e4..9049216 100644
--- a/easysql-api/src/main/java/cc/carm/lib/easysql/api/SQLAction.java
+++ b/easysql-api/src/main/java/cc/carm/lib/easysql/api/SQLAction.java
@@ -13,14 +13,14 @@ import java.util.function.Function;
  * SQLAction 是用于承载SQL语句并进行处理、返回的基本类。
  *
  * <ul>
- *     <li>同步执行 {@link #execute()}, {@link #execute(Function, BiConsumer)}</li>
+ *     <li>同步执行 {@link #execute()}, {@link #execute(Function, BiConsumer)}
  *     <br>同步执行方法中有会抛出异常的方法与不抛出异常的方法，
- *     <br>若选择不抛出异常，则返回值可能为空，需要特殊处理。
+ *     <br>若选择不抛出异常，则返回值可能为空，需要特殊处理。</li>
  *
- *     <li>异步执行 {@link #executeAsync(Consumer, BiConsumer)}</li>
+ *     <li>异步执行 {@link #executeAsync(Consumer, BiConsumer)}
  *     <br>异步执行时将提供成功与异常两种处理方式
  *     <br>可自行选择是否对数据或异常进行处理
- *     <br>默认的异常处理器为 {@link #defaultExceptionHandler()}
+ *     <br>默认的异常处理器为 {@link #defaultExceptionHandler()}</li>
  * </ul>
  *
  * <b>注意： 无论是否异步，都不需要自行关闭ResultSet，本API已自动关闭</b>
diff --git a/easysql-api/src/main/java/cc/carm/lib/easysql/api/SQLManager.java b/easysql-api/src/main/java/cc/carm/lib/easysql/api/SQLManager.java
index ee8d81e..90b4c68 100644
--- a/easysql-api/src/main/java/cc/carm/lib/easysql/api/SQLManager.java
+++ b/easysql-api/src/main/java/cc/carm/lib/easysql/api/SQLManager.java
@@ -2,6 +2,8 @@ package cc.carm.lib.easysql.api;
 
 import cc.carm.lib.easysql.api.action.PreparedSQLUpdateAction;
 import cc.carm.lib.easysql.api.action.PreparedSQLUpdateBatchAction;
+import cc.carm.lib.easysql.api.action.SQLUpdateAction;
+import cc.carm.lib.easysql.api.action.SQLUpdateBatchAction;
 import cc.carm.lib.easysql.api.action.query.SQLQuery;
 import cc.carm.lib.easysql.api.builder.*;
 import org.jetbrains.annotations.NotNull;
@@ -34,6 +36,7 @@ public interface SQLManager {
 	 * 得到一个数据库连接实例
 	 *
 	 * @return Connection
+	 * @throws SQLException 见 {@link DataSource#getConnection()}
 	 */
 	@NotNull Connection getConnection() throws SQLException;
 
@@ -49,14 +52,17 @@ public interface SQLManager {
 	 *
 	 * @param sql SQL语句内容
 	 * @return 更新的行数
+	 * @see SQLUpdateAction
 	 */
 	@Nullable Integer executeSQL(String sql);
 
 	/**
-	 * 执行一条不需要返回结果的SQL更改(UPDATE、REPLACE、DELETE)
+	 * 执行一条不需要返回结果的预处理SQL更改(UPDATE、REPLACE、DELETE)
 	 *
-	 * @param sql SQL语句内容
+	 * @param sql    SQL语句内容
+	 * @param params SQL语句中 ? 的对应参数
 	 * @return 更新的行数
+	 * @see PreparedSQLUpdateAction
 	 */
 	@Nullable Integer executeSQL(String sql, Object[] params);
 
@@ -65,6 +71,7 @@ public interface SQLManager {
 	 *
 	 * @param sql SQL语句内容
 	 * @return 对应参数返回的行数
+	 * @see PreparedSQLUpdateBatchAction
 	 */
 	@Nullable List<Integer> executeSQLBatch(String sql, Iterable<Object[]> paramsBatch);
 
@@ -72,8 +79,10 @@ public interface SQLManager {
 	/**
 	 * 执行多条不需要返回结果的SQL。
 	 *
-	 * @param sql SQL语句内容
+	 * @param sql     SQL语句内容
+	 * @param moreSQL 更多SQL语句内容
 	 * @return 对应参数返回的行数
+	 * @see SQLUpdateBatchAction
 	 */
 	@Nullable List<Integer> executeSQLBatch(@NotNull String sql, String... moreSQL);
 
@@ -85,20 +94,67 @@ public interface SQLManager {
 	 */
 	@Nullable List<Integer> executeSQLBatch(@NotNull Iterable<String> sqlBatch);
 
+	/**
+	 * 在库中创建一个表
+	 *
+	 * @param tableName 表名
+	 * @return {@link TableCreateBuilder}
+	 */
 	TableCreateBuilder createTable(@NotNull String tableName);
 
+	/**
+	 * 新建一个查询
+	 *
+	 * @return {@link QueryBuilder}
+	 */
 	QueryBuilder createQuery();
 
-	InsertBuilder<PreparedSQLUpdateBatchAction> createInsertBatch(@NotNull String tableName);
-
+	/**
+	 * 创建一条插入操作
+	 *
+	 * @param tableName 目标表名
+	 * @return {@link InsertBuilder}
+	 */
 	InsertBuilder<PreparedSQLUpdateAction> createInsert(@NotNull String tableName);
 
-	ReplaceBuilder<PreparedSQLUpdateBatchAction> createReplaceBatch(@NotNull String tableName);
+	/**
+	 * 创建支持多组数据的插入操作
+	 *
+	 * @param tableName 目标表名
+	 * @return {@link InsertBuilder}
+	 */
+	InsertBuilder<PreparedSQLUpdateBatchAction> createInsertBatch(@NotNull String tableName);
 
+	/**
+	 * 创建一条替换操作
+	 *
+	 * @param tableName 目标表名
+	 * @return {@link ReplaceBuilder}
+	 */
 	ReplaceBuilder<PreparedSQLUpdateAction> createReplace(@NotNull String tableName);
 
+	/**
+	 * 创建支持多组数据的替换操作
+	 *
+	 * @param tableName 目标表名
+	 * @return {@link ReplaceBuilder}
+	 */
+	ReplaceBuilder<PreparedSQLUpdateBatchAction> createReplaceBatch(@NotNull String tableName);
+
+	/**
+	 * 创建更新操作
+	 *
+	 * @param tableName 目标表名
+	 * @return {@link UpdateBuilder}
+	 */
 	UpdateBuilder createUpdate(@NotNull String tableName);
 
+	/**
+	 * 创建删除操作
+	 *
+	 * @param tableName 目标表名
+	 * @return {@link DeleteBuilder}
+	 */
 	DeleteBuilder createDelete(@NotNull String tableName);
 
 }