From 9ebb5a89b1d991fc189c9f28c1e0ae6bebaff82f Mon Sep 17 00:00:00 2001 From: "nathan.xu" Date: Sat, 9 Nov 2024 12:00:22 -0500 Subject: [PATCH 1/5] improve some Javadocs in sql package --- .../src/main/java/org/hibernate/sql/Delete.java | 2 +- .../main/java/org/hibernate/sql/ForUpdateFragment.java | 2 +- .../src/main/java/org/hibernate/sql/InFragment.java | 2 +- .../src/main/java/org/hibernate/sql/Insert.java | 2 +- .../main/java/org/hibernate/sql/NullnessRestriction.java | 2 +- .../src/main/java/org/hibernate/sql/SimpleSelect.java | 2 +- .../src/main/java/org/hibernate/sql/Template.java | 4 ++-- .../src/main/java/org/hibernate/sql/Update.java | 2 +- .../src/main/java/org/hibernate/sql/ast/Clause.java | 8 ++------ .../main/java/org/hibernate/sql/ast/SqlAstJoinType.java | 2 +- .../main/java/org/hibernate/sql/ast/SqlAstTranslator.java | 4 ++-- .../src/main/java/org/hibernate/sql/ast/package-info.java | 2 +- .../hibernate/sql/ast/spi/AbstractSqlAstTranslator.java | 2 +- .../org/hibernate/sql/ast/spi/SqlAliasBaseManager.java | 2 +- .../org/hibernate/sql/ast/spi/SqlAstCreationContext.java | 2 +- .../org/hibernate/sql/ast/spi/SqlAstCreationState.java | 2 +- .../org/hibernate/sql/ast/spi/SqlAstProcessingState.java | 2 +- .../main/java/org/hibernate/sql/ast/spi/package-info.java | 2 +- .../java/org/hibernate/sql/exec/spi/JdbcLockStrategy.java | 2 +- .../sql/exec/spi/JdbcOperationQueryAnonBlock.java | 2 +- .../results/internal/NavigablePathMapToInitializer.java | 8 +++++--- .../hibernate/sql/results/spi/ListResultsConsumer.java | 4 ++-- .../java/org/hibernate/sql/results/spi/RowReader.java | 4 ++-- 23 files changed, 32 insertions(+), 34 deletions(-) diff --git a/hibernate-core/src/main/java/org/hibernate/sql/Delete.java b/hibernate-core/src/main/java/org/hibernate/sql/Delete.java index bc00167d7021..8273f9e5f389 100644 --- a/hibernate-core/src/main/java/org/hibernate/sql/Delete.java +++ b/hibernate-core/src/main/java/org/hibernate/sql/Delete.java @@ -13,7 +13,7 @@ import org.hibernate.sql.ast.spi.ParameterMarkerStrategy; /** - * A SQL {@code DELETE} statement. + * An SQL {@code DELETE} statement. * * @author Gavin King */ diff --git a/hibernate-core/src/main/java/org/hibernate/sql/ForUpdateFragment.java b/hibernate-core/src/main/java/org/hibernate/sql/ForUpdateFragment.java index 6f034a20d8f9..d14c0053fc81 100644 --- a/hibernate-core/src/main/java/org/hibernate/sql/ForUpdateFragment.java +++ b/hibernate-core/src/main/java/org/hibernate/sql/ForUpdateFragment.java @@ -14,7 +14,7 @@ import org.hibernate.internal.util.StringHelper; /** - * A SQL {FOR UPDATE} clause. + * An SQL {@code FOR UPDATE} clause. * * @author Gavin King */ diff --git a/hibernate-core/src/main/java/org/hibernate/sql/InFragment.java b/hibernate-core/src/main/java/org/hibernate/sql/InFragment.java index 5a17b2ab83c7..69a18b663d51 100644 --- a/hibernate-core/src/main/java/org/hibernate/sql/InFragment.java +++ b/hibernate-core/src/main/java/org/hibernate/sql/InFragment.java @@ -12,7 +12,7 @@ import org.hibernate.internal.util.StringHelper; /** - * A SQL {@code IN} expression. + * An SQL {@code IN} expression. * * @author Gavin King */ diff --git a/hibernate-core/src/main/java/org/hibernate/sql/Insert.java b/hibernate-core/src/main/java/org/hibernate/sql/Insert.java index e4dbd7d7bd7a..70ca912aa055 100644 --- a/hibernate-core/src/main/java/org/hibernate/sql/Insert.java +++ b/hibernate-core/src/main/java/org/hibernate/sql/Insert.java @@ -18,7 +18,7 @@ /** - * A SQL {@code INSERT} statement. + * An SQL {@code INSERT} statement. * * @author Gavin King */ diff --git a/hibernate-core/src/main/java/org/hibernate/sql/NullnessRestriction.java b/hibernate-core/src/main/java/org/hibernate/sql/NullnessRestriction.java index b8a1dc581924..fd77e22e6266 100644 --- a/hibernate-core/src/main/java/org/hibernate/sql/NullnessRestriction.java +++ b/hibernate-core/src/main/java/org/hibernate/sql/NullnessRestriction.java @@ -7,7 +7,7 @@ import org.hibernate.Internal; /** - * Nullness restriction - IS (NOT)? NULL + * Nullness restriction - IS (NOT) NULL ? * * @author Steve Ebersole */ diff --git a/hibernate-core/src/main/java/org/hibernate/sql/SimpleSelect.java b/hibernate-core/src/main/java/org/hibernate/sql/SimpleSelect.java index 4b12127d5c08..e5323621928e 100644 --- a/hibernate-core/src/main/java/org/hibernate/sql/SimpleSelect.java +++ b/hibernate-core/src/main/java/org/hibernate/sql/SimpleSelect.java @@ -20,7 +20,7 @@ import org.hibernate.sql.ast.spi.ParameterMarkerStrategy; /** - * A SQL {@code SELECT} statement with no table joins. + * An SQL {@code SELECT} statement with no table joins. * * @author Gavin King */ diff --git a/hibernate-core/src/main/java/org/hibernate/sql/Template.java b/hibernate-core/src/main/java/org/hibernate/sql/Template.java index 2be9d04f1cb5..23d9e4a8ed1c 100644 --- a/hibernate-core/src/main/java/org/hibernate/sql/Template.java +++ b/hibernate-core/src/main/java/org/hibernate/sql/Template.java @@ -23,12 +23,12 @@ * should be written in the native SQL dialect of the target database, * with the following special exceptions: *