Skip to content

Commit 143736e

Browse files
committed
Enforce order of Javadoc tags for records
Closes gh-33403
1 parent e0cb7aa commit 143736e

File tree

5 files changed

+9
-9
lines changed

5 files changed

+9
-9
lines changed

spring-beans/src/main/java/org/springframework/beans/factory/aot/BeanRegistrationKey.java

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2002-2023 the original author or authors.
2+
* Copyright 2002-2024 the original author or authors.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -19,10 +19,10 @@
1919
/**
2020
* Record class holding key information for beans registered in a bean factory.
2121
*
22-
* @param beanName the name of the registered bean
23-
* @param beanClass the type of the registered bean
2422
* @author Brian Clozel
2523
* @since 6.0.8
24+
* @param beanName the name of the registered bean
25+
* @param beanClass the type of the registered bean
2626
*/
2727
record BeanRegistrationKey(String beanName, Class<?> beanClass) {
2828
}

spring-beans/src/main/java/org/springframework/beans/factory/support/MethodDescriptor.java

+2-2
Original file line numberDiff line numberDiff line change
@@ -25,11 +25,11 @@
2525
* reference to the method's {@linkplain #declaringClass declaring class},
2626
* {@linkplain #methodName name}, and {@linkplain #parameterTypes parameter types}.
2727
*
28+
* @author Sam Brannen
29+
* @since 6.0.11
2830
* @param declaringClass the method's declaring class
2931
* @param methodName the name of the method
3032
* @param parameterTypes the types of parameters accepted by the method
31-
* @author Sam Brannen
32-
* @since 6.0.11
3333
*/
3434
record MethodDescriptor(Class<?> declaringClass, String methodName, Class<?>... parameterTypes) {
3535

spring-beans/src/main/java/org/springframework/beans/factory/support/RegisteredBean.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -267,10 +267,10 @@ public String toString() {
267267
* is usually the declaring class of the {@code executable} (in case of a constructor
268268
* or a locally declared factory method), there are cases where retaining the actual
269269
* concrete class is necessary (e.g. for an inherited factory method).
270+
* @since 6.1.7
270271
* @param executable the {@link Executable} ({@link java.lang.reflect.Constructor}
271272
* or {@link java.lang.reflect.Method}) to invoke
272273
* @param targetClass the target {@link Class} of the executable
273-
* @since 6.1.7
274274
*/
275275
public record InstantiationDescriptor(Executable executable, Class<?> targetClass) {
276276

spring-web/src/main/java/org/springframework/http/ETag.java

+2-2
Original file line numberDiff line numberDiff line change
@@ -27,10 +27,10 @@
2727
/**
2828
* Represents an ETag for HTTP conditional requests.
2929
*
30-
* @param tag the unquoted tag value
31-
* @param weak whether the entity tag is for weak or strong validation
3230
* @author Rossen Stoyanchev
3331
* @since 5.3.38
32+
* @param tag the unquoted tag value
33+
* @param weak whether the entity tag is for weak or strong validation
3434
* @see <a href="https://datatracker.ietf.org/doc/html/rfc7232">RFC 7232</a>
3535
*/
3636
public record ETag(String tag, boolean weak) {

src/checkstyle/checkstyle.xml

+1-1
Original file line numberDiff line numberDiff line change
@@ -179,7 +179,7 @@
179179
<property name="offset" value="0"/>
180180
</module>
181181
<module name="com.puppycrawl.tools.checkstyle.checks.javadoc.AtclauseOrderCheck">
182-
<property name="target" value="CLASS_DEF, INTERFACE_DEF, ENUM_DEF"/>
182+
<property name="target" value="CLASS_DEF, INTERFACE_DEF, ENUM_DEF, RECORD_DEF"/>
183183
<property name="tagOrder" value="@author, @since, @param, @see, @version, @serial, @deprecated"/>
184184
</module>
185185
<module name="com.puppycrawl.tools.checkstyle.checks.javadoc.AtclauseOrderCheck">

0 commit comments

Comments
 (0)