From be996971e807228aea72a60f0d94d07ea20689ec Mon Sep 17 00:00:00 2001
From: Suomm <1474983351@qq.com>
Date: Thu, 13 Jul 2023 08:17:28 +0800
Subject: [PATCH] =?UTF-8?q?style:=20=E4=BC=98=E5=8C=96=20javadoc=20?=
 =?UTF-8?q?=E6=B3=A8=E9=87=8A=E3=80=82?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 .../annotation/RelationManyToMany.java         | 11 ++++++++---
 .../annotation/RelationManyToOne.java          | 16 ++++++++++++++--
 .../annotation/RelationOneToMany.java          | 18 +++++++++++++++---
 .../annotation/RelationOneToOne.java           | 16 ++++++++++++++--
 4 files changed, 51 insertions(+), 10 deletions(-)

diff --git a/mybatis-flex-annotation/src/main/java/com/mybatisflex/annotation/RelationManyToMany.java b/mybatis-flex-annotation/src/main/java/com/mybatisflex/annotation/RelationManyToMany.java
index 24427249..2e2ad6f6 100644
--- a/mybatis-flex-annotation/src/main/java/com/mybatisflex/annotation/RelationManyToMany.java
+++ b/mybatis-flex-annotation/src/main/java/com/mybatisflex/annotation/RelationManyToMany.java
@@ -42,7 +42,13 @@ public @interface RelationManyToMany {
     String targetSchema() default "";
 
     /**
-     * 目标实体类对应的表，一般情况下，关联数据不是 entity，而是 vo、dto 等需要配置此项
+     * <p>
+     * 目标实体类对应的表名。
+     *
+     * <p>
+     * 如果目标实体类没有使用 {@code @Table(value = "...")} 指定表名时，
+     * 需要在这里指定对应表的表名。一般关联数据不是 entity 对象，而是 vo、dto
+     * 等需要配置此项。
      *
      * @return 表名
      */
@@ -77,7 +83,7 @@ public @interface RelationManyToMany {
 	String joinTargetColumn();
 
     /**
-     * 查询时，追加的额外条件
+     * 查询时，追加的额外条件。
      */
 	Condition[] extraConditions() default {};
 
@@ -95,5 +101,4 @@ public @interface RelationManyToMany {
 	 */
 	String dataSource() default "";
 
-
 }
diff --git a/mybatis-flex-annotation/src/main/java/com/mybatisflex/annotation/RelationManyToOne.java b/mybatis-flex-annotation/src/main/java/com/mybatisflex/annotation/RelationManyToOne.java
index 6c406f34..9a1efb8e 100644
--- a/mybatis-flex-annotation/src/main/java/com/mybatisflex/annotation/RelationManyToOne.java
+++ b/mybatis-flex-annotation/src/main/java/com/mybatisflex/annotation/RelationManyToOne.java
@@ -35,14 +35,26 @@ public @interface RelationManyToOne {
     String selfField();
 
     /**
-     * 目标实体类对应的表的 schema，一般情况下，关联数据不是 entity，而是 vo、dto 等需要配置此项
+     * <p>
+     * 目标实体类对应的表的 schema 模式。
+     *
+     * <p>
+     * 如果目标实体类没有使用 {@code @Table(schema = "...")} 指定 schema 时，
+     * 需要在这里指定对应表的 schema 值。一般关联数据不是 entity 对象，而是 vo、dto
+     * 等需要配置此项。
      *
      * @return schema 名称
      */
     String targetSchema() default "";
 
     /**
-     * 目标实体类对应的表，一般情况下，关联数据不是 entity，而是 vo、dto 等需要配置此项
+     * <p>
+     * 目标实体类对应的表名。
+     *
+     * <p>
+     * 如果目标实体类没有使用 {@code @Table(value = "...")} 指定表名时，
+     * 需要在这里指定对应表的表名。一般关联数据不是 entity 对象，而是 vo、dto
+     * 等需要配置此项。
      *
      * @return 表名
      */
diff --git a/mybatis-flex-annotation/src/main/java/com/mybatisflex/annotation/RelationOneToMany.java b/mybatis-flex-annotation/src/main/java/com/mybatisflex/annotation/RelationOneToMany.java
index 6fec3ec7..172659a9 100644
--- a/mybatis-flex-annotation/src/main/java/com/mybatisflex/annotation/RelationOneToMany.java
+++ b/mybatis-flex-annotation/src/main/java/com/mybatisflex/annotation/RelationOneToMany.java
@@ -35,14 +35,26 @@ public @interface RelationOneToMany {
 	String selfField() default "";
 
     /**
-     * 目标实体类对应的表的 schema，一般情况下，关联数据不是 entity，而是 vo、dto 等需要配置此项
+     * <p>
+     * 目标实体类对应的表的 schema 模式。
+     *
+     * <p>
+     * 如果目标实体类没有使用 {@code @Table(schema = "...")} 指定 schema 时，
+     * 需要在这里指定对应表的 schema 值。一般关联数据不是 entity 对象，而是 vo、dto
+     * 等需要配置此项。
      *
      * @return schema 名称
      */
     String targetSchema() default "";
 
     /**
-     * 目标实体类对应的表，一般情况下，关联数据不是 entity，而是 vo、dto 等需要配置此项
+     * <p>
+     * 目标实体类对应的表名。
+     *
+     * <p>
+     * 如果目标实体类没有使用 {@code @Table(value = "...")} 指定表名时，
+     * 需要在这里指定对应表的表名。一般关联数据不是 entity 对象，而是 vo、dto
+     * 等需要配置此项。
      *
      * @return 表名
      */
@@ -77,7 +89,7 @@ public @interface RelationOneToMany {
     String joinTargetColumn() default "";
 
     /**
-     * 查询时，追加的额外条件
+     * 查询时，追加的额外条件。
      */
     Condition[] extraConditions() default {};
 
diff --git a/mybatis-flex-annotation/src/main/java/com/mybatisflex/annotation/RelationOneToOne.java b/mybatis-flex-annotation/src/main/java/com/mybatisflex/annotation/RelationOneToOne.java
index 2d5a5dd3..47aacdae 100644
--- a/mybatis-flex-annotation/src/main/java/com/mybatisflex/annotation/RelationOneToOne.java
+++ b/mybatis-flex-annotation/src/main/java/com/mybatisflex/annotation/RelationOneToOne.java
@@ -35,14 +35,26 @@ public @interface RelationOneToOne {
     String selfField() default "";
 
     /**
-     * 目标实体类对应的表的 schema，一般情况下，关联数据不是 entity，而是 vo、dto 等需要配置此项
+     * <p>
+     * 目标实体类对应的表的 schema 模式。
+     *
+     * <p>
+     * 如果目标实体类没有使用 {@code @Table(schema = "...")} 指定 schema 时，
+     * 需要在这里指定对应表的 schema 值。一般关联数据不是 entity 对象，而是 vo、dto
+     * 等需要配置此项。
      *
      * @return schema 名称
      */
     String targetSchema() default "";
 
     /**
-     * 目标实体类对应的表，一般情况下，关联数据不是 entity，而是 vo、dto 等需要配置此项
+     * <p>
+     * 目标实体类对应的表名。
+     *
+     * <p>
+     * 如果目标实体类没有使用 {@code @Table(value = "...")} 指定表名时，
+     * 需要在这里指定对应表的表名。一般关联数据不是 entity 对象，而是 vo、dto
+     * 等需要配置此项。
      *
      * @return 表名
      */