Skip to content

Commit 5af3fcc

Browse files
committed
Fix JavaDoc.
Self closing <p/> tags cause build failures now. Closes #1059
1 parent fc3067c commit 5af3fcc

20 files changed

+88
-66
lines changed

spring-data-relational/src/main/java/org/springframework/data/relational/core/conversion/DbAction.java

+3-4
Original file line numberDiff line numberDiff line change
@@ -236,7 +236,7 @@ public String toString() {
236236
* <p>
237237
* Note that deletes for contained entities that reference the root are to be represented by separate
238238
* {@link DbAction}s.
239-
*
239+
* </p>
240240
* @param <T> type of the entity for which this represents a database interaction.
241241
*/
242242
final class DeleteRoot<T> implements DbAction<T> {
@@ -300,7 +300,7 @@ public String toString() {
300300
* <p>
301301
* Note that deletes for contained entities that reference the root are to be represented by separate
302302
* {@link DbAction}s.
303-
*
303+
* </p>
304304
* @param <T> type of the entity for which this represents a database interaction.
305305
*/
306306
final class DeleteAllRoot<T> implements DbAction<T> {
@@ -322,7 +322,6 @@ public String toString() {
322322

323323
/**
324324
* Represents an acquire lock statement for a aggregate root when only the ID is known.
325-
* <p>
326325
*
327326
* @param <T> type of the entity for which this represents a database interaction.
328327
*/
@@ -392,7 +391,7 @@ interface WithDependingOn<T> extends WithPropertyPath<T>, WithEntity<T> {
392391
* Additional values to be set during insert or update statements.
393392
* <p>
394393
* Values come from parent entities but one might also add values manually.
395-
*
394+
* </p>
396395
* @return guaranteed to be not {@code null}.
397396
*/
398397
Map<PersistentPropertyPath<RelationalPersistentProperty>, Object> getQualifiers();

spring-data-relational/src/main/java/org/springframework/data/relational/core/mapping/Embedded.java

+6-4
Original file line numberDiff line numberDiff line change
@@ -27,10 +27,11 @@
2727

2828
/**
2929
* The annotation to configure a value object as embedded in the current table.
30-
* <p />
30+
* <p>
3131
* Depending on the {@link OnEmpty value} of {@link #onEmpty()} the property is set to {@literal null} or an empty
3232
* instance in the case all embedded values are {@literal null} when reading from the result set.
33-
*
33+
* </p>
34+
*
3435
* @author Bastian Wilhelm
3536
* @author Christoph Strobl
3637
* @since 1.1
@@ -42,9 +43,10 @@
4243

4344
/**
4445
* Set the load strategy for the embedded object if all contained fields yield {@literal null} values.
45-
* <p />
46+
* <p>
4647
* {@link Nullable @Embedded.Nullable} and {@link Empty @Embedded.Empty} offer shortcuts for this.
47-
*
48+
* </p>
49+
*
4850
* @return never {@link} null.
4951
*/
5052
OnEmpty onEmpty();

spring-data-relational/src/main/java/org/springframework/data/relational/core/mapping/event/BeforeDeleteCallback.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ public interface BeforeDeleteCallback<T> extends EntityCallback<T> {
3737
* account for deleting. Only transient fields of the entity should be changed in this callback.
3838
*
3939
* @param aggregate the aggregate.
40-
* @param aggregateChange the associated {@link DefaultAggregateChange}.
40+
* @param aggregateChange the associated {@link MutableAggregateChange}.
4141
* @return the aggregate to be deleted.
4242
*/
4343
T onBeforeDelete(T aggregate, MutableAggregateChange<T> aggregateChange);

spring-data-relational/src/main/java/org/springframework/data/relational/core/sql/AssignValue.java

+2-2
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,9 @@
1919

2020
/**
2121
* Assign a {@link Expression} to a {@link Column}.
22-
* <p/>
22+
* <p>
2323
* Results in a rendered assignment: {@code <column> = <value>} (e.g. {@code col = 'foo'}.
24-
*
24+
* </p>
2525
* @author Mark Paluch
2626
* @since 1.1
2727
*/

spring-data-relational/src/main/java/org/springframework/data/relational/core/sql/AsteriskFromTable.java

+4-3
Original file line numberDiff line numberDiff line change
@@ -17,15 +17,16 @@
1717

1818
/**
1919
* {@link Segment} to select all columns from a {@link Table}.
20-
* <p/>
21-
* * Renders to: {@code
20+
* <p>
21+
* Renders to: {@code
2222
*
2323
<table>
2424
* .*} as in {@code SELECT
2525
*
2626
<table>
2727
* .* FROM …}.
28-
*
28+
* </p>
29+
*
2930
* @author Mark Paluch
3031
* @since 1.1
3132
* @see Table#asterisk()

spring-data-relational/src/main/java/org/springframework/data/relational/core/sql/Between.java

+3-2
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,10 @@
1919

2020
/**
2121
* BETWEEN {@link Condition} comparing between {@link Expression}s.
22-
* <p/>
22+
* <p>
2323
* Results in a rendered condition: {@code <left> BETWEEN <begin> AND <end>}.
24-
*
24+
* </p>
25+
*
2526
* @author Mark Paluch
2627
* @since 2.2
2728
*/

spring-data-relational/src/main/java/org/springframework/data/relational/core/sql/Column.java

+3-2
Original file line numberDiff line numberDiff line change
@@ -20,9 +20,10 @@
2020

2121
/**
2222
* Column name within a {@code SELECT … FROM} clause.
23-
* <p/>
23+
* <p>
2424
* Renders to: {@code <name>} or {@code <table(alias)>.<name>}.
25-
*
25+
* </p>
26+
*
2627
* @author Mark Paluch
2728
* @author Jens Schauder
2829
* @since 1.1

spring-data-relational/src/main/java/org/springframework/data/relational/core/sql/Comparison.java

+8-5
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,10 @@
1919

2020
/**
2121
* Comparing {@link Condition} comparing two {@link Expression}s.
22-
* <p/>
22+
* <p>
2323
* Results in a rendered condition: {@code <left> <comparator> <right>} (e.g. {@code col = 'predicate'}.
24-
*
24+
* </p>
25+
*
2526
* @author Mark Paluch
2627
* @author Jens Schauder
2728
* @since 1.1
@@ -61,11 +62,13 @@ public static Comparison create(Expression leftColumnOrExpression, String compar
6162

6263
/**
6364
* Creates a new {@link Comparison} from simple {@literal StringP} arguments
64-
* @param unqualifiedColumnName gets turned in a {@link Expressions#just(String)} and is expected to be an unqualified unique column name but also could be an verbatim expression. Must not be {@literal null}.
65+
*
66+
* @param unqualifiedColumnName gets turned in a {@link Expressions#just(String)} and is expected to be an unqualified
67+
* unique column name but also could be an verbatim expression. Must not be {@literal null}.
6568
* @param comparator must not be {@literal null}.
6669
* @param rightValue is considered a {@link Literal}. Must not be {@literal null}.
67-
* @return a new {@literal Comparison} of the first with the third argument using the second argument as comparison operator. Guaranteed to be not {@literal null}.
68-
*
70+
* @return a new {@literal Comparison} of the first with the third argument using the second argument as comparison
71+
* operator. Guaranteed to be not {@literal null}.
6972
* @since 2.3
7073
*/
7174
public static Comparison create(String unqualifiedColumnName, String comparator, Object rightValue) {

spring-data-relational/src/main/java/org/springframework/data/relational/core/sql/DeleteValidator.java

+3-2
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,10 @@
1717

1818
/**
1919
* Validator for {@link Delete} statements.
20-
* <p/>
20+
* <p>
2121
* Validates that all {@link Column}s using a table qualifier have a table import from the {@code FROM} clause.
22-
*
22+
* </p>
23+
*
2324
* @author Mark Paluch
2425
* @since 1.1
2526
*/

spring-data-relational/src/main/java/org/springframework/data/relational/core/sql/Join.java

+3-2
Original file line numberDiff line numberDiff line change
@@ -17,12 +17,13 @@
1717

1818
/**
1919
* {@link Segment} for a {@code JOIN} declaration.
20-
* <p/>
20+
* <p>
2121
* Renders to: {@code JOIN
2222
*
2323
<table>
2424
* ON <condition>}.
25-
*
25+
* </p>
26+
*
2627
* @author Mark Paluch
2728
* @since 1.1
2829
*/

spring-data-relational/src/main/java/org/springframework/data/relational/core/sql/Like.java

+2-2
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,9 @@
1919

2020
/**
2121
* LIKE {@link Condition} comparing two {@link Expression}s.
22-
* <p/>
22+
* <p>
2323
* Results in a rendered condition: {@code <left> LIKE <right>}.
24-
*
24+
* </p>
2525
* @author Mark Paluch
2626
* @since 1.1
2727
*/

spring-data-relational/src/main/java/org/springframework/data/relational/core/sql/SQL.java

+3-2
Original file line numberDiff line numberDiff line change
@@ -22,9 +22,10 @@
2222
/**
2323
* Utility to create SQL {@link Segment}s. Typically used as entry point to the Statement Builder. Objects and dependent
2424
* objects created by the Query AST are immutable except for builders.
25-
* <p/>
25+
* <p>
2626
* The Statement Builder API is intended for framework usage to produce SQL required for framework operations.
27-
*
27+
* </p>
28+
*
2829
* @author Mark Paluch
2930
* @author Jens Schauder
3031
* @since 1.1

spring-data-relational/src/main/java/org/springframework/data/relational/core/sql/Segment.java

+9-6
Original file line numberDiff line numberDiff line change
@@ -26,9 +26,10 @@ public interface Segment extends Visitable {
2626

2727
/**
2828
* Check whether this {@link Segment} is equal to another {@link Segment}.
29-
* <p/>
29+
* <p>
3030
* Equality is typically given if the {@link #toString()} representation matches.
31-
*
31+
* </p>
32+
*
3233
* @param other the reference object with which to compare.
3334
* @return {@literal true} if this object is the same as the {@code other} argument; {@literal false} otherwise.
3435
*/
@@ -37,22 +38,24 @@ public interface Segment extends Visitable {
3738

3839
/**
3940
* Generate a hash code from this{@link Segment}.
40-
* <p/>
41+
* <p>
4142
* Hashcode typically derives from the {@link #toString()} representation so two {@link Segment}s yield the same
4243
* {@link #hashCode()} if their {@link #toString()} representation matches.
43-
*
44+
* </p>
45+
*
4446
* @return a hash code value for this object.
4547
*/
4648
@Override
4749
int hashCode();
4850

4951
/**
5052
* Return a SQL string representation of this {@link Segment}.
51-
* <p/>
53+
* <p>
5254
* The representation is intended for debugging purposes and an approximation to the generated SQL. While it might
5355
* work in the context of a specific dialect, you should not that the {@link #toString()} representation works across
5456
* multiple databases.
55-
*
57+
* </p>
58+
*
5659
* @return a SQL string representation of this {@link Segment}.
5760
*/
5861
@Override

spring-data-relational/src/main/java/org/springframework/data/relational/core/sql/SelectValidator.java

+2-2
Original file line numberDiff line numberDiff line change
@@ -21,10 +21,10 @@
2121

2222
/**
2323
* Validator for {@link Select} statements.
24-
* <p/>
24+
* <p>
2525
* Validates that all {@link Column}s using a table qualifier have a table import from either the {@code FROM} or
2626
* {@code JOIN} clause.
27-
*
27+
* </p>
2828
* @author Mark Paluch
2929
* @author Jens Schauder
3030
* @since 1.1

spring-data-relational/src/main/java/org/springframework/data/relational/core/sql/Table.java

+13-12
Original file line numberDiff line numberDiff line change
@@ -25,9 +25,10 @@
2525
/**
2626
* Represents a table reference within an SQL statement. Typically used to denote {@code FROM} or {@code JOIN} or to
2727
* prefix a {@link Column}.
28-
* <p/>
28+
* <p>
2929
* Renders to: {@code <name>} or {@code <name> AS <name>}.
30-
*
30+
* </p>
31+
*
3132
* @author Mark Paluch
3233
* @since 1.1
3334
*/
@@ -114,10 +115,10 @@ public Table as(SqlIdentifier alias) {
114115

115116
/**
116117
* Creates a new {@link Column} associated with this {@link Table}.
117-
* <p/>
118+
* <p>
118119
* Note: This {@link Table} does not track column creation and there is no possibility to enumerate all
119120
* {@link Column}s that were created for this table.
120-
*
121+
*</p>
121122
* @param name column name, must not be {@literal null} or empty.
122123
* @return a new {@link Column} associated with this {@link Table}.
123124
*/
@@ -130,10 +131,10 @@ public Column column(String name) {
130131

131132
/**
132133
* Creates a new {@link Column} associated with this {@link Table}.
133-
* <p/>
134+
* <p>
134135
* Note: This {@link Table} does not track column creation and there is no possibility to enumerate all
135136
* {@link Column}s that were created for this table.
136-
*
137+
*</p>
137138
* @param name column name, must not be {@literal null} or empty.
138139
* @return a new {@link Column} associated with this {@link Table}.
139140
* @since 2.0
@@ -147,10 +148,10 @@ public Column column(SqlIdentifier name) {
147148

148149
/**
149150
* Creates a {@link List} of {@link Column}s associated with this {@link Table}.
150-
* <p/>
151+
* <p>
151152
* Note: This {@link Table} does not track column creation and there is no possibility to enumerate all
152153
* {@link Column}s that were created for this table.
153-
*
154+
*</p>
154155
* @param names column names, must not be {@literal null} or empty.
155156
* @return a new {@link List} of {@link Column}s associated with this {@link Table}.
156157
*/
@@ -163,10 +164,10 @@ public List<Column> columns(String... names) {
163164

164165
/**
165166
* Creates a {@link List} of {@link Column}s associated with this {@link Table}.
166-
* <p/>
167+
* <p>
167168
* Note: This {@link Table} does not track column creation and there is no possibility to enumerate all
168169
* {@link Column}s that were created for this table.
169-
*
170+
*</p>
170171
* @param names column names, must not be {@literal null} or empty.
171172
* @return a new {@link List} of {@link Column}s associated with this {@link Table}.
172173
* @since 2.0
@@ -185,10 +186,10 @@ public List<Column> columns(SqlIdentifier... names) {
185186

186187
/**
187188
* Creates a {@link List} of {@link Column}s associated with this {@link Table}.
188-
* <p/>
189+
* <p>
189190
* Note: This {@link Table} does not track column creation and there is no possibility to enumerate all
190191
* {@link Column}s that were created for this table.
191-
*
192+
*</p>
192193
* @param names column names, must not be {@literal null} or empty.
193194
* @return a new {@link List} of {@link Column}s associated with this {@link Table}.
194195
*/

spring-data-relational/src/main/java/org/springframework/data/relational/core/sql/UpdateBuilder.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ public interface UpdateBuilder {
2929
/**
3030
* Configure the {@link Table} to which the update is applied.
3131
*
32-
* @param count the top count.
32+
* @param table the table to update.
3333
* @return {@code this} {@link SelectBuilder}.
3434
*/
3535
UpdateAssign table(Table table);

spring-data-relational/src/main/java/org/springframework/data/relational/core/sql/package-info.java

+3-2
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,10 @@
33
* Statement Builder implementation. Use {@link org.springframework.data.relational.core.sql.StatementBuilder} to create
44
* statements and {@link org.springframework.data.relational.core.sql.SQL} to create SQL objects. Objects and dependent
55
* objects created by the Statement Builder are immutable except for builders.
6-
* <p/>
6+
* <p>
77
* The Statement Builder API is intended for framework usage to produce SQL required for framework operations.
8-
*
8+
* </p>
9+
*
910
* @since 1.1
1011
*/
1112
@NonNullApi

0 commit comments

Comments
 (0)