From 143736e59bd6a361050e4660a0a957e8686135e8 Mon Sep 17 00:00:00 2001
From: Sam Brannen <104798+sbrannen@users.noreply.github.com>
Date: Sun, 18 Aug 2024 13:01:43 +0200
Subject: [PATCH] Enforce order of Javadoc tags for records
Closes gh-33403
---
.../beans/factory/aot/BeanRegistrationKey.java | 6 +++---
.../beans/factory/support/MethodDescriptor.java | 4 ++--
.../beans/factory/support/RegisteredBean.java | 2 +-
spring-web/src/main/java/org/springframework/http/ETag.java | 4 ++--
src/checkstyle/checkstyle.xml | 2 +-
5 files changed, 9 insertions(+), 9 deletions(-)
diff --git a/spring-beans/src/main/java/org/springframework/beans/factory/aot/BeanRegistrationKey.java b/spring-beans/src/main/java/org/springframework/beans/factory/aot/BeanRegistrationKey.java
index ffd3f99c9c7..cc23256f6c4 100644
--- a/spring-beans/src/main/java/org/springframework/beans/factory/aot/BeanRegistrationKey.java
+++ b/spring-beans/src/main/java/org/springframework/beans/factory/aot/BeanRegistrationKey.java
@@ -1,5 +1,5 @@
/*
- * Copyright 2002-2023 the original author or authors.
+ * Copyright 2002-2024 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -19,10 +19,10 @@ package org.springframework.beans.factory.aot;
/**
* Record class holding key information for beans registered in a bean factory.
*
- * @param beanName the name of the registered bean
- * @param beanClass the type of the registered bean
* @author Brian Clozel
* @since 6.0.8
+ * @param beanName the name of the registered bean
+ * @param beanClass the type of the registered bean
*/
record BeanRegistrationKey(String beanName, Class> beanClass) {
}
diff --git a/spring-beans/src/main/java/org/springframework/beans/factory/support/MethodDescriptor.java b/spring-beans/src/main/java/org/springframework/beans/factory/support/MethodDescriptor.java
index 6b0e4e90a92..6670d5116f2 100644
--- a/spring-beans/src/main/java/org/springframework/beans/factory/support/MethodDescriptor.java
+++ b/spring-beans/src/main/java/org/springframework/beans/factory/support/MethodDescriptor.java
@@ -25,11 +25,11 @@ import org.springframework.util.ClassUtils;
* reference to the method's {@linkplain #declaringClass declaring class},
* {@linkplain #methodName name}, and {@linkplain #parameterTypes parameter types}.
*
+ * @author Sam Brannen
+ * @since 6.0.11
* @param declaringClass the method's declaring class
* @param methodName the name of the method
* @param parameterTypes the types of parameters accepted by the method
- * @author Sam Brannen
- * @since 6.0.11
*/
record MethodDescriptor(Class> declaringClass, String methodName, Class>... parameterTypes) {
diff --git a/spring-beans/src/main/java/org/springframework/beans/factory/support/RegisteredBean.java b/spring-beans/src/main/java/org/springframework/beans/factory/support/RegisteredBean.java
index da3b8e6ec39..f59b5cb2643 100644
--- a/spring-beans/src/main/java/org/springframework/beans/factory/support/RegisteredBean.java
+++ b/spring-beans/src/main/java/org/springframework/beans/factory/support/RegisteredBean.java
@@ -267,10 +267,10 @@ public final class RegisteredBean {
* is usually the declaring class of the {@code executable} (in case of a constructor
* or a locally declared factory method), there are cases where retaining the actual
* concrete class is necessary (e.g. for an inherited factory method).
+ * @since 6.1.7
* @param executable the {@link Executable} ({@link java.lang.reflect.Constructor}
* or {@link java.lang.reflect.Method}) to invoke
* @param targetClass the target {@link Class} of the executable
- * @since 6.1.7
*/
public record InstantiationDescriptor(Executable executable, Class> targetClass) {
diff --git a/spring-web/src/main/java/org/springframework/http/ETag.java b/spring-web/src/main/java/org/springframework/http/ETag.java
index e279ac6a05b..6f7027b5ef0 100644
--- a/spring-web/src/main/java/org/springframework/http/ETag.java
+++ b/spring-web/src/main/java/org/springframework/http/ETag.java
@@ -27,10 +27,10 @@ import org.springframework.util.StringUtils;
/**
* Represents an ETag for HTTP conditional requests.
*
- * @param tag the unquoted tag value
- * @param weak whether the entity tag is for weak or strong validation
* @author Rossen Stoyanchev
* @since 5.3.38
+ * @param tag the unquoted tag value
+ * @param weak whether the entity tag is for weak or strong validation
* @see RFC 7232
*/
public record ETag(String tag, boolean weak) {
diff --git a/src/checkstyle/checkstyle.xml b/src/checkstyle/checkstyle.xml
index 5b24c009a74..bef287af00f 100644
--- a/src/checkstyle/checkstyle.xml
+++ b/src/checkstyle/checkstyle.xml
@@ -179,7 +179,7 @@
-
+