From 27d52131760428480cb9e073c9c1a14b4b8378df Mon Sep 17 00:00:00 2001
From: Sam Brannen <104798+sbrannen@users.noreply.github.com>
Date: Thu, 14 Mar 2024 13:44:27 +0100
Subject: [PATCH] =?UTF-8?q?Polish=20Javadoc=20for=20@=E2=81=A0TestBean=20s?=
 =?UTF-8?q?upport?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 .../bean/override/convention/TestBean.java    | 24 ++++++++++++-------
 .../convention/TestBeanOverrideProcessor.java |  8 +++----
 2 files changed, 19 insertions(+), 13 deletions(-)

diff --git a/spring-test/src/main/java/org/springframework/test/context/bean/override/convention/TestBean.java b/spring-test/src/main/java/org/springframework/test/context/bean/override/convention/TestBean.java
index d9afaab178..4a712c60e9 100644
--- a/spring-test/src/main/java/org/springframework/test/context/bean/override/convention/TestBean.java
+++ b/spring-test/src/main/java/org/springframework/test/context/bean/override/convention/TestBean.java
@@ -28,7 +28,7 @@ import org.springframework.test.context.bean.override.BeanOverride;
 /**
  * Mark a field to override a bean instance in the {@code BeanFactory}.
  *
- * <p>The instance is created from a no-arg static factory method in the test
+ * <p>The instance is created from a zero-argument static factory method in the test
  * class whose return type is compatible with the annotated field. The method
  * is deduced as follows.
  * <ul>
@@ -77,8 +77,8 @@ import org.springframework.test.context.bean.override.BeanOverride;
  * }</code></pre>
  *
  * <p>By default, the name of the bean to override is inferred from the name of
- * the annotated field. To use a different bean name, set the {@link #name()}
- * attribute.
+ * the annotated field. To use a different bean name, set the {@link #value()} or
+ * {@link #name()} attribute.
  *
  * @author Simon Baslé
  * @author Stephane Nicoll
@@ -93,22 +93,27 @@ import org.springframework.test.context.bean.override.BeanOverride;
 public @interface TestBean {
 
 	/**
-	 * Required suffix for a factory method that overrides a bean instance that
-	 * is detected by convention.
+	 * Required suffix for the name of a factory method that overrides a bean
+	 * instance when the factory method is detected by convention.
+	 * @see #methodName()
 	 */
 	String CONVENTION_SUFFIX = "TestOverride";
 
 
 	/**
 	 * Alias for {@link #name()}.
+	 * <p>Intended to be used when no other attributes are needed &mdash; for
+	 * example, {@code @TestBean("customBeanName")}.
+	 * @see #name()
 	 */
 	@AliasFor("name")
 	String value() default "";
 
 	/**
 	 * Name of the bean to override.
-	 * <p>Defaults to {@code ""} (the empty String) to signal that the name of
-	 * the annotated field should be used as the bean name.
+	 * <p>If left unspecified, the name of the bean to override is the name of
+	 * the annotated field. If specified, the field name is ignored.
+	 * @see #value()
 	 */
 	@AliasFor("value")
 	String name() default "";
@@ -116,8 +121,9 @@ public @interface TestBean {
 	/**
 	 * Name of a static factory method to look for in the test class, which will
 	 * be used to instantiate the bean to override.
-	 * <p>Defaults to {@code ""} (the empty String) to signal that the factory
-	 * method should be detected based on convention.
+	 * <p>If left unspecified, the name of the factory method will be detected
+	 * based on convention.
+	 * @see #CONVENTION_SUFFIX
 	 */
 	String methodName() default "";
 
diff --git a/spring-test/src/main/java/org/springframework/test/context/bean/override/convention/TestBeanOverrideProcessor.java b/spring-test/src/main/java/org/springframework/test/context/bean/override/convention/TestBeanOverrideProcessor.java
index 0ee2c171f8..e31239daf8 100644
--- a/spring-test/src/main/java/org/springframework/test/context/bean/override/convention/TestBeanOverrideProcessor.java
+++ b/spring-test/src/main/java/org/springframework/test/context/bean/override/convention/TestBeanOverrideProcessor.java
@@ -53,10 +53,10 @@ public class TestBeanOverrideProcessor implements BeanOverrideProcessor {
 	 * Find a test bean factory {@link Method} in the given {@link Class} which
 	 * meets the following criteria.
 	 * <ul>
-	 * <li>The method is static.
-	 * <li>The method does not accept any arguments.
-	 * <li>The method's return type matches the supplied {@code methodReturnType}.
-	 * <li>The method's name is one of the supplied {@code methodNames}.
+	 * <li>The method is static.</li>
+	 * <li>The method does not accept any arguments.</li>
+	 * <li>The method's return type matches the supplied {@code methodReturnType}.</li>
+	 * <li>The method's name is one of the supplied {@code methodNames}.</li>
 	 * </ul>
 	 * @param clazz the class in which to search for the factory method
 	 * @param methodReturnType the return type for the factory method