From 4983a802a7a9c8b2bf2ecbea39733b85c0d4a5c6 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?St=C3=A9phane=20Nicoll?= Date: Sat, 9 Mar 2024 15:53:49 +0100 Subject: [PATCH] Polish "Fix Javadoc" See gh-32403 --- .../aop/testfixture/mixin/LockMixin.java | 9 ++---- .../factory/support/MethodDescriptor.java | 9 +++--- .../beans/ExtendedBeanInfoTests.java | 2 +- .../core/BridgeMethodResolver.java | 4 +-- .../NestedRepeatableAnnotationsTests.java | 1 - .../spel/ast/FunctionReference.java | 4 +-- ...ariosForSpringSecurityExpressionTests.java | 4 +-- .../init/H2DatabasePopulatorTests.java | 14 ++------- .../messaging/simp/SimpMessagingTemplate.java | 4 +-- ...agerTestExecutionEventPublishingTests.java | 1 - ...s.java => AutowiredRuleSpr15927Tests.java} | 4 +-- ...ntextLoaderUtilsContextHierarchyTests.java | 19 +++--------- .../bind/ServletRequestUtilsBenchmark.java | 4 ++- .../AbstractListenerWriteProcessor.java | 3 +- .../mvc/UrlFilenameViewControllerTests.java | 3 +- .../web/servlet/tags/form/ErrorsTagTests.java | 30 ++++--------------- .../tags/form/PasswordInputTagTests.java | 15 ++-------- 17 files changed, 38 insertions(+), 92 deletions(-) rename spring-test/src/test/java/org/springframework/test/context/junit4/rules/{AutowiredRuleTests.java => AutowiredRuleSpr15927Tests.java} (94%) diff --git a/spring-aop/src/testFixtures/java/org/springframework/aop/testfixture/mixin/LockMixin.java b/spring-aop/src/testFixtures/java/org/springframework/aop/testfixture/mixin/LockMixin.java index 7d4ec1a6be1..6c08f24ce2f 100644 --- a/spring-aop/src/testFixtures/java/org/springframework/aop/testfixture/mixin/LockMixin.java +++ b/spring-aop/src/testFixtures/java/org/springframework/aop/testfixture/mixin/LockMixin.java @@ -44,9 +44,6 @@ public class LockMixin extends DelegatingIntroductionInterceptor implements Lock this.locked = false; } - /** - * @see org.springframework.aop.testfixture.mixin.Lockable#locked() - */ @Override public boolean locked() { return this.locked; @@ -54,10 +51,8 @@ public class LockMixin extends DelegatingIntroductionInterceptor implements Lock /** * Note that we need to override around advice. - * If the method is a setter and we're locked, prevent execution. - * Otherwise let super.invoke() handle it, and do normal - * Lockable(this) then target behaviour. - * @see org.aopalliance.intercept.MethodInterceptor#invoke(MethodInvocation) + * If the method is a setter, and we're locked, prevent execution. + * Otherwise, let super.invoke() handle it. */ @Override public Object invoke(MethodInvocation invocation) throws Throwable { 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 03ddf5c2248..6b0e4e90a92 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 @@ -16,10 +16,12 @@ package org.springframework.beans.factory.support; +import java.lang.reflect.Method; + import org.springframework.util.ClassUtils; /** - * Descriptor for a {@link java.lang.reflect.Method Method} which holds a + * Descriptor for a {@link Method Method} which holds a * reference to the method's {@linkplain #declaringClass declaring class}, * {@linkplain #methodName name}, and {@linkplain #parameterTypes parameter types}. * @@ -33,9 +35,8 @@ record MethodDescriptor(Class declaringClass, String methodName, Class... /** * Create a {@link MethodDescriptor} for the supplied bean class and method name. - *

The supplied {@code methodName} may be a {@linkplain java.lang.reflect.Method#getName() - * simple method name} or a - * {@linkplain org.springframework.util.ClassUtils#getQualifiedMethodName(java.lang.reflect.Method) + *

The supplied {@code methodName} may be a {@linkplain Method#getName() + * simple method name} or a {@linkplain ClassUtils#getQualifiedMethodName(Method) * qualified method name}. *

If the method name is fully qualified, this utility will parse the * method name and its declaring class from the qualified method name and then diff --git a/spring-beans/src/test/java/org/springframework/beans/ExtendedBeanInfoTests.java b/spring-beans/src/test/java/org/springframework/beans/ExtendedBeanInfoTests.java index a648bf23cfb..99682ea16e0 100644 --- a/spring-beans/src/test/java/org/springframework/beans/ExtendedBeanInfoTests.java +++ b/spring-beans/src/test/java/org/springframework/beans/ExtendedBeanInfoTests.java @@ -554,7 +554,7 @@ class ExtendedBeanInfoTests { * IntrospectionException regarding a "type mismatch between indexed and non-indexed * methods" intermittently (approximately one out of every four times) under JDK 7 * due to non-deterministic results from {@link Class#getDeclaredMethods()}. - * @see JDK-7023180 : Change in specified-to-be-unspecified ordering of getDeclaredMethods causes application problems + * @see JDK-7023180 * @see #cornerSpr9702() */ @Test diff --git a/spring-core/src/main/java/org/springframework/core/BridgeMethodResolver.java b/spring-core/src/main/java/org/springframework/core/BridgeMethodResolver.java index d4ad9505200..c2bd54988db 100644 --- a/spring-core/src/main/java/org/springframework/core/BridgeMethodResolver.java +++ b/spring-core/src/main/java/org/springframework/core/BridgeMethodResolver.java @@ -266,9 +266,9 @@ public final class BridgeMethodResolver { /** * Compare the signatures of the bridge method and the method which it bridges. If * the parameter and return types are the same, it is a 'visibility' bridge method - * introduced in Java 6 to fix JDK-6342411. + * introduced in Java 6 to fix + * JDK-6342411. * @return whether signatures match as described - * @see Java bridge methods explained */ public static boolean isVisibilityBridgeMethodPair(Method bridgeMethod, Method bridgedMethod) { if (bridgeMethod == bridgedMethod) { diff --git a/spring-core/src/test/java/org/springframework/core/annotation/NestedRepeatableAnnotationsTests.java b/spring-core/src/test/java/org/springframework/core/annotation/NestedRepeatableAnnotationsTests.java index b6e88e7c13d..6e20b597361 100644 --- a/spring-core/src/test/java/org/springframework/core/annotation/NestedRepeatableAnnotationsTests.java +++ b/spring-core/src/test/java/org/springframework/core/annotation/NestedRepeatableAnnotationsTests.java @@ -39,7 +39,6 @@ import static org.assertj.core.api.Assertions.assertThat; * * @author Sam Brannen * @since 5.3.24 - * @see gh-20279 */ @SuppressWarnings("unused") class NestedRepeatableAnnotationsTests { diff --git a/spring-expression/src/main/java/org/springframework/expression/spel/ast/FunctionReference.java b/spring-expression/src/main/java/org/springframework/expression/spel/ast/FunctionReference.java index 1bcc196f963..0387b65ef33 100644 --- a/spring-expression/src/main/java/org/springframework/expression/spel/ast/FunctionReference.java +++ b/spring-expression/src/main/java/org/springframework/expression/spel/ast/FunctionReference.java @@ -163,8 +163,8 @@ public class FunctionReference extends SpelNodeImpl { /** * Execute a function represented as {@link MethodHandle}. *

Method types that take no arguments (fully bound handles or static methods - * with no parameters) can use {@link MethodHandle#invoke(Object... var1)} which is the most - * efficient. Otherwise, {@link MethodHandle#invokeWithArguments(Object... arguments)} is used. + * with no parameters) can use {@link MethodHandle#invoke(Object...)} which is the most + * efficient. Otherwise, {@link MethodHandle#invokeWithArguments(Object...)} is used. * @param state the expression evaluation state * @param methodHandle the method handle to invoke * @return the return value of the invoked Java method diff --git a/spring-expression/src/test/java/org/springframework/expression/spel/ScenariosForSpringSecurityExpressionTests.java b/spring-expression/src/test/java/org/springframework/expression/spel/ScenariosForSpringSecurityExpressionTests.java index 8d57a86491d..6f5b42af3c9 100644 --- a/spring-expression/src/test/java/org/springframework/expression/spel/ScenariosForSpringSecurityExpressionTests.java +++ b/spring-expression/src/test/java/org/springframework/expression/spel/ScenariosForSpringSecurityExpressionTests.java @@ -37,11 +37,11 @@ import org.springframework.expression.spel.support.StandardEvaluationContext; import static org.assertj.core.api.Assertions.assertThat; -///CLOVER:OFF /** - * Spring Security scenarios from Expressing Authorization with SpEL + * SpEL expression tests for Spring Security scenarios. * * @author Andy Clement + * @see Expressing Authorization with SpEL */ class ScenariosForSpringSecurityExpressionTests extends AbstractExpressionTests { diff --git a/spring-jdbc/src/test/java/org/springframework/jdbc/datasource/init/H2DatabasePopulatorTests.java b/spring-jdbc/src/test/java/org/springframework/jdbc/datasource/init/H2DatabasePopulatorTests.java index 1f897a85713..e3fb9fce4ed 100644 --- a/spring-jdbc/src/test/java/org/springframework/jdbc/datasource/init/H2DatabasePopulatorTests.java +++ b/spring-jdbc/src/test/java/org/springframework/jdbc/datasource/init/H2DatabasePopulatorTests.java @@ -43,12 +43,7 @@ class H2DatabasePopulatorTests extends AbstractDatabasePopulatorTests { return EmbeddedDatabaseType.H2; } - /** - * SPR-15896 - * - * @since 5.0 - */ - @Test + @Test // SPR-15896 void scriptWithH2Alias() { databasePopulator.addScript(usersSchema()); databasePopulator.addScript(resource("db-test-data-h2-alias.sql")); @@ -61,12 +56,7 @@ class H2DatabasePopulatorTests extends AbstractDatabasePopulatorTests { assertThat(jdbcTemplate.queryForObject(sql, String.class)).isEqualTo("maS"); } - /** - * gh-27008 - * - * @since 5.3.11 - */ - @Test + @Test // gh-27008 void automaticallyCommitsIfAutoCommitIsDisabled() throws Exception { EmbeddedDatabase database = null; try { diff --git a/spring-messaging/src/main/java/org/springframework/messaging/simp/SimpMessagingTemplate.java b/spring-messaging/src/main/java/org/springframework/messaging/simp/SimpMessagingTemplate.java index 5df97e571f2..fdd5f357a77 100644 --- a/spring-messaging/src/main/java/org/springframework/messaging/simp/SimpMessagingTemplate.java +++ b/spring-messaging/src/main/java/org/springframework/messaging/simp/SimpMessagingTemplate.java @@ -130,8 +130,8 @@ public class SimpMessagingTemplate extends AbstractMessageSendingTemplateIf a destination header is not already present ,the message is sent - * to the configured {@link AbstractMessageSendingTemplate#setDefaultDestination(Object) defaultDestination} - * or an exception an {@code IllegalStateException} is raised if that isn't + * to the configured {@link AbstractMessageSendingTemplate#setDefaultDestination(Object) + * defaultDestination} or an {@code IllegalStateException} is raised if that isn't * configured. * @param message the message to send (never {@code null}) */ diff --git a/spring-test/src/test/java/org/springframework/test/context/event/EagerTestExecutionEventPublishingTests.java b/spring-test/src/test/java/org/springframework/test/context/event/EagerTestExecutionEventPublishingTests.java index 6d6dc4b444c..feaa2c936f5 100644 --- a/spring-test/src/test/java/org/springframework/test/context/event/EagerTestExecutionEventPublishingTests.java +++ b/spring-test/src/test/java/org/springframework/test/context/event/EagerTestExecutionEventPublishingTests.java @@ -50,7 +50,6 @@ import static org.junit.platform.engine.discovery.DiscoverySelectors.selectClass * * @author Sam Brannen * @since 5.3.17 - * @see gh-27757 */ class EagerTestExecutionEventPublishingTests { diff --git a/spring-test/src/test/java/org/springframework/test/context/junit4/rules/AutowiredRuleTests.java b/spring-test/src/test/java/org/springframework/test/context/junit4/rules/AutowiredRuleSpr15927Tests.java similarity index 94% rename from spring-test/src/test/java/org/springframework/test/context/junit4/rules/AutowiredRuleTests.java rename to spring-test/src/test/java/org/springframework/test/context/junit4/rules/AutowiredRuleSpr15927Tests.java index 70e651968ec..e4b26bfabd0 100644 --- a/spring-test/src/test/java/org/springframework/test/context/junit4/rules/AutowiredRuleTests.java +++ b/spring-test/src/test/java/org/springframework/test/context/junit4/rules/AutowiredRuleSpr15927Tests.java @@ -30,12 +30,12 @@ import org.springframework.context.annotation.Configuration; import static org.assertj.core.api.Assertions.assertThat; /** - * Integration tests for an issue raised in SPR-15927. + * Integration tests for {@code SPR-15927}. * * @author Sam Brannen * @since 5.0 */ -public class AutowiredRuleTests { +public class AutowiredRuleSpr15927Tests { @ClassRule public static final SpringClassRule springClassRule = new SpringClassRule(); diff --git a/spring-test/src/test/java/org/springframework/test/context/support/ContextLoaderUtilsContextHierarchyTests.java b/spring-test/src/test/java/org/springframework/test/context/support/ContextLoaderUtilsContextHierarchyTests.java index ce715283d30..26769c38e1f 100644 --- a/spring-test/src/test/java/org/springframework/test/context/support/ContextLoaderUtilsContextHierarchyTests.java +++ b/spring-test/src/test/java/org/springframework/test/context/support/ContextLoaderUtilsContextHierarchyTests.java @@ -327,10 +327,7 @@ class ContextLoaderUtilsContextHierarchyTests extends AbstractContextConfigurati assertContextConfigEntriesAreNotUnique(SingleTestClassWithMultiLevelContextHierarchyWithDuplicatedContextConfig.class); } - /** - * Used to reproduce bug reported in SPR-10997 - */ - @Test + @Test // SPR-10997 void buildContextHierarchyMapForTestClassHierarchyWithMultiLevelContextHierarchiesAndOverriddenInitializers() { Map> map = buildContextHierarchyMap(TestClass2WithMultiLevelContextHierarchyWithOverriddenInitializers.class); @@ -504,32 +501,24 @@ class ContextLoaderUtilsContextHierarchyTests extends AbstractContextConfigurati private static class SingleTestClassWithMultiLevelContextHierarchyWithDuplicatedContextConfig { } - /** - * Used to reproduce bug reported in SPR-10997 - */ @ContextHierarchy({// // @ContextConfiguration(name = "alpha", locations = "1-A.xml"),// @ContextConfiguration(name = "beta", locations = "1-B.xml") // - }) + }) // SPR-10997 private static class TestClass1WithMultiLevelContextHierarchyWithUniqueContextConfig { } - /** - * Used to reproduce bug reported in SPR-10997 - */ @ContextHierarchy({// // @ContextConfiguration(name = "alpha", initializers = DummyApplicationContextInitializer.class),// @ContextConfiguration(name = "beta", initializers = DummyApplicationContextInitializer.class) // - }) + }) // SPR-10997 private static class TestClass2WithMultiLevelContextHierarchyWithOverriddenInitializers extends TestClass1WithMultiLevelContextHierarchyWithUniqueContextConfig { } - /** - * Used to reproduce bug reported in SPR-10997 - */ + // SPR-10997 private static class DummyApplicationContextInitializer implements ApplicationContextInitializer { diff --git a/spring-web/src/jmh/java/org/springframework/web/bind/ServletRequestUtilsBenchmark.java b/spring-web/src/jmh/java/org/springframework/web/bind/ServletRequestUtilsBenchmark.java index a6d9ced6eb9..47dcb1a5994 100644 --- a/spring-web/src/jmh/java/org/springframework/web/bind/ServletRequestUtilsBenchmark.java +++ b/spring-web/src/jmh/java/org/springframework/web/bind/ServletRequestUtilsBenchmark.java @@ -16,6 +16,7 @@ package org.springframework.web.bind; +import jakarta.servlet.ServletRequest; import org.openjdk.jmh.annotations.Benchmark; import org.openjdk.jmh.annotations.BenchmarkMode; import org.openjdk.jmh.annotations.Mode; @@ -26,7 +27,8 @@ import org.springframework.web.testfixture.servlet.MockHttpServletRequest; /** - * Benchmarks for extracting parameters from {@link jakarta.servlet.ServletRequest}. + * Benchmarks for extracting parameters from {@link ServletRequest}. + * * @author Brian Clozel */ @BenchmarkMode(Mode.Throughput) diff --git a/spring-web/src/main/java/org/springframework/http/server/reactive/AbstractListenerWriteProcessor.java b/spring-web/src/main/java/org/springframework/http/server/reactive/AbstractListenerWriteProcessor.java index d48990beb95..957e4fe51fa 100644 --- a/spring-web/src/main/java/org/springframework/http/server/reactive/AbstractListenerWriteProcessor.java +++ b/spring-web/src/main/java/org/springframework/http/server/reactive/AbstractListenerWriteProcessor.java @@ -69,8 +69,7 @@ public abstract class AbstractListenerWriteProcessor implements Processorgh-273 + * place prior to calling AsyncContext.complete(). See also gh-273. */ private volatile boolean readyToCompleteAfterLastWrite; diff --git a/spring-webmvc/src/test/java/org/springframework/web/servlet/mvc/UrlFilenameViewControllerTests.java b/spring-webmvc/src/test/java/org/springframework/web/servlet/mvc/UrlFilenameViewControllerTests.java index ce27f267a4b..b17ab58cd08 100644 --- a/spring-webmvc/src/test/java/org/springframework/web/servlet/mvc/UrlFilenameViewControllerTests.java +++ b/spring-webmvc/src/test/java/org/springframework/web/servlet/mvc/UrlFilenameViewControllerTests.java @@ -170,9 +170,8 @@ class UrlFilenameViewControllerTests { /** * This is the expected behavior, and it now has a test to prove it. - * @see SPR-2789 */ - @PathPatternsParameterizedTest + @PathPatternsParameterizedTest // SPR-2789 void nestedPathisUsedAsViewName_InBreakingChangeFromSpring12Line( Function requestFactory) throws Exception { diff --git a/spring-webmvc/src/test/java/org/springframework/web/servlet/tags/form/ErrorsTagTests.java b/spring-webmvc/src/test/java/org/springframework/web/servlet/tags/form/ErrorsTagTests.java index 2ec4ff6819c..34c1d96d799 100644 --- a/spring-webmvc/src/test/java/org/springframework/web/servlet/tags/form/ErrorsTagTests.java +++ b/spring-webmvc/src/test/java/org/springframework/web/servlet/tags/form/ErrorsTagTests.java @@ -355,10 +355,7 @@ public class ErrorsTagTests extends AbstractFormTagTests { assertThat(getPageContext().getAttribute(ErrorsTag.MESSAGES_ATTRIBUTE)).isEqualTo(existingAttribute); } - /** - * SPR-2788 - */ - @Test + @Test // SPR-2788 void asBodyTagWithErrorsAndExistingMessagesAttributeInNonPageScopeAreNotClobbered() throws Exception { String existingAttribute = "something"; getPageContext().setAttribute(ErrorsTag.MESSAGES_ATTRIBUTE, existingAttribute, PageContext.APPLICATION_SCOPE); @@ -379,42 +376,27 @@ public class ErrorsTagTests extends AbstractFormTagTests { assertThat(getPageContext().getAttribute(ErrorsTag.MESSAGES_ATTRIBUTE, PageContext.APPLICATION_SCOPE)).isEqualTo(existingAttribute); } - /** - * SPR-2788 - */ - @Test + @Test // SPR-2788 void asBodyTagWithNoErrorsAndExistingMessagesAttributeInApplicationScopeAreNotClobbered() throws Exception { assertWhenNoErrorsExistingMessagesInScopeAreNotClobbered(PageContext.APPLICATION_SCOPE); } - /** - * SPR-2788 - */ - @Test + @Test // SPR-2788 void asBodyTagWithNoErrorsAndExistingMessagesAttributeInSessionScopeAreNotClobbered() throws Exception { assertWhenNoErrorsExistingMessagesInScopeAreNotClobbered(PageContext.SESSION_SCOPE); } - /** - * SPR-2788 - */ - @Test + @Test // SPR-2788 void asBodyTagWithNoErrorsAndExistingMessagesAttributeInPageScopeAreNotClobbered() throws Exception { assertWhenNoErrorsExistingMessagesInScopeAreNotClobbered(PageContext.PAGE_SCOPE); } - /** - * SPR-2788 - */ - @Test + @Test // SPR-2788 void asBodyTagWithNoErrorsAndExistingMessagesAttributeInRequestScopeAreNotClobbered() throws Exception { assertWhenNoErrorsExistingMessagesInScopeAreNotClobbered(PageContext.REQUEST_SCOPE); } - /** - * SPR-4005 - */ - @Test + @Test // SPR-4005 void omittedPathMatchesObjectErrorsOnly() throws Exception { this.tag.setPath(null); Errors errors = new BeanPropertyBindingResult(new TestBean(), "COMMAND_NAME"); diff --git a/spring-webmvc/src/test/java/org/springframework/web/servlet/tags/form/PasswordInputTagTests.java b/spring-webmvc/src/test/java/org/springframework/web/servlet/tags/form/PasswordInputTagTests.java index c8d9e6768e9..cb1cfaacbb7 100644 --- a/spring-webmvc/src/test/java/org/springframework/web/servlet/tags/form/PasswordInputTagTests.java +++ b/spring-webmvc/src/test/java/org/springframework/web/servlet/tags/form/PasswordInputTagTests.java @@ -31,10 +31,7 @@ import static org.assertj.core.api.Assertions.assertThatIllegalArgumentException */ class PasswordInputTagTests extends InputTagTests { - /** - * SPR-2866 - */ - @Test + @Test // SPR-2866 void passwordValueIsNotRenderedByDefault() throws Exception { this.getTag().setPath("name"); @@ -48,10 +45,7 @@ class PasswordInputTagTests extends InputTagTests { assertValueAttribute(output, ""); } - /** - * SPR-2866 - */ - @Test + @Test // SPR-2866 void passwordValueIsRenderedIfShowPasswordAttributeIsSetToTrue() throws Exception { this.getTag().setPath("name"); this.getPasswordTag().setShowPassword(true); @@ -66,10 +60,7 @@ class PasswordInputTagTests extends InputTagTests { assertValueAttribute(output, "Rob"); } - /** - * SPR-2866 - */ - @Test + @Test // >SPR-2866 void passwordValueIsNotRenderedIfShowPasswordAttributeIsSetToFalse() throws Exception { this.getTag().setPath("name"); this.getPasswordTag().setShowPassword(false);