Skip to content

Commit accf7ff

Browse files
committed
Merge pull request #32403 from qeeqez
* pr/32403: Polish "Fix Javadoc" Fix Javadoc Closes gh-32403
2 parents c1287d4 + 4983a80 commit accf7ff

File tree

22 files changed

+56
-110
lines changed

22 files changed

+56
-110
lines changed

spring-aop/src/testFixtures/java/org/springframework/aop/testfixture/mixin/LockMixin.java

+3-8
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.
@@ -44,20 +44,15 @@ public void unlock() {
4444
this.locked = false;
4545
}
4646

47-
/**
48-
* @see test.mixin.AopProxyTests.Lockable#locked()
49-
*/
5047
@Override
5148
public boolean locked() {
5249
return this.locked;
5350
}
5451

5552
/**
5653
* Note that we need to override around advice.
57-
* If the method is a setter and we're locked, prevent execution.
58-
* Otherwise let super.invoke() handle it, and do normal
59-
* Lockable(this) then target behaviour.
60-
* @see org.aopalliance.MethodInterceptor#invoke(org.aopalliance.MethodInvocation)
54+
* If the method is a setter, and we're locked, prevent execution.
55+
* Otherwise, let super.invoke() handle it.
6156
*/
6257
@Override
6358
public Object invoke(MethodInvocation invocation) throws Throwable {

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

+5-4
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.
@@ -16,10 +16,12 @@
1616

1717
package org.springframework.beans.factory.support;
1818

19+
import java.lang.reflect.Method;
20+
1921
import org.springframework.util.ClassUtils;
2022

2123
/**
22-
* Descriptor for a {@link java.lang.reflect.Method Method} which holds a
24+
* Descriptor for a {@link Method Method} which holds a
2325
* reference to the method's {@linkplain #declaringClass declaring class},
2426
* {@linkplain #methodName name}, and {@linkplain #parameterTypes parameter types}.
2527
*
@@ -34,8 +36,7 @@ record MethodDescriptor(Class<?> declaringClass, String methodName, Class<?>...
3436
/**
3537
* Create a {@link MethodDescriptor} for the supplied bean class and method name.
3638
* <p>The supplied {@code methodName} may be a {@linkplain Method#getName()
37-
* simple method name} or a
38-
* {@linkplain org.springframework.util.ClassUtils#getQualifiedMethodName(Method)
39+
* simple method name} or a {@linkplain ClassUtils#getQualifiedMethodName(Method)
3940
* qualified method name}.
4041
* <p>If the method name is fully qualified, this utility will parse the
4142
* method name and its declaring class from the qualified method name and then

spring-beans/src/test/java/org/springframework/beans/ExtendedBeanInfoTests.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -554,7 +554,7 @@ class C {
554554
* IntrospectionException regarding a "type mismatch between indexed and non-indexed
555555
* methods" intermittently (approximately one out of every four times) under JDK 7
556556
* due to non-deterministic results from {@link Class#getDeclaredMethods()}.
557-
* See https://bugs.java.com/bugdatabase/view_bug.do?bug_id=7023180
557+
* @see <a href="https://bugs.java.com/bugdatabase/view_bug.do?bug_id=7023180">JDK-7023180</a>
558558
* @see #cornerSpr9702()
559559
*/
560560
@Test

spring-core/src/main/java/org/springframework/core/BridgeMethodResolver.java

+2-2
Original file line numberDiff line numberDiff line change
@@ -266,8 +266,8 @@ private static Method searchForMatch(Class<?> type, Method bridgeMethod) {
266266
/**
267267
* Compare the signatures of the bridge method and the method which it bridges. If
268268
* the parameter and return types are the same, it is a 'visibility' bridge method
269-
* introduced in Java 6 to fix https://bugs.openjdk.org/browse/JDK-6342411.
270-
* See also https://stas-blogspot.blogspot.com/2010/03/java-bridge-methods-explained.html
269+
* introduced in Java 6 to fix <a href="https://bugs.openjdk.org/browse/JDK-6342411">
270+
* JDK-6342411</a>.
271271
* @return whether signatures match as described
272272
*/
273273
public static boolean isVisibilityBridgeMethodPair(Method bridgeMethod, Method bridgedMethod) {

spring-core/src/test/java/org/springframework/core/annotation/NestedRepeatableAnnotationsTests.java

+1-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2002-2022 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.
@@ -39,7 +39,6 @@
3939
*
4040
* @author Sam Brannen
4141
* @since 5.3.24
42-
* @see https://github.com/spring-projects/spring-framework/issues/20279
4342
*/
4443
@SuppressWarnings("unused")
4544
class NestedRepeatableAnnotationsTests {

spring-expression/src/main/java/org/springframework/expression/spel/ast/FunctionReference.java

+2-2
Original file line numberDiff line numberDiff line change
@@ -163,8 +163,8 @@ private TypedValue executeFunctionViaMethod(ExpressionState state, Method method
163163
/**
164164
* Execute a function represented as {@link MethodHandle}.
165165
* <p>Method types that take no arguments (fully bound handles or static methods
166-
* with no parameters) can use {@link MethodHandle#invoke()} which is the most
167-
* efficient. Otherwise, {@link MethodHandle#invokeWithArguments()} is used.
166+
* with no parameters) can use {@link MethodHandle#invoke(Object...)} which is the most
167+
* efficient. Otherwise, {@link MethodHandle#invokeWithArguments(Object...)} is used.
168168
* @param state the expression evaluation state
169169
* @param methodHandle the method handle to invoke
170170
* @return the return value of the invoked Java method

spring-expression/src/test/java/org/springframework/expression/spel/ScenariosForSpringSecurityExpressionTests.java

+2-2
Original file line numberDiff line numberDiff line change
@@ -37,11 +37,11 @@
3737

3838
import static org.assertj.core.api.Assertions.assertThat;
3939

40-
///CLOVER:OFF
4140
/**
42-
* Spring Security scenarios from https://docs.spring.io/spring-security/reference/servlet/authorization/expression-based.html
41+
* SpEL expression tests for Spring Security scenarios.
4342
*
4443
* @author Andy Clement
44+
* @see <a href="https://docs.spring.io/spring-security/reference/servlet/authorization/authorize-http-requests.html#authorization-expressions">Expressing Authorization with SpEL</a>
4545
*/
4646
class ScenariosForSpringSecurityExpressionTests extends AbstractExpressionTests {
4747

spring-jdbc/src/test/java/org/springframework/jdbc/datasource/init/H2DatabasePopulatorTests.java

+2-12
Original file line numberDiff line numberDiff line change
@@ -43,12 +43,7 @@ protected EmbeddedDatabaseType getEmbeddedDatabaseType() {
4343
return EmbeddedDatabaseType.H2;
4444
}
4545

46-
/**
47-
* https://jira.spring.io/browse/SPR-15896
48-
*
49-
* @since 5.0
50-
*/
51-
@Test
46+
@Test // SPR-15896
5247
void scriptWithH2Alias() {
5348
databasePopulator.addScript(usersSchema());
5449
databasePopulator.addScript(resource("db-test-data-h2-alias.sql"));
@@ -61,12 +56,7 @@ void scriptWithH2Alias() {
6156
assertThat(jdbcTemplate.queryForObject(sql, String.class)).isEqualTo("maS");
6257
}
6358

64-
/**
65-
* https://github.com/spring-projects/spring-framework/issues/27008
66-
*
67-
* @since 5.3.11
68-
*/
69-
@Test
59+
@Test // gh-27008
7060
void automaticallyCommitsIfAutoCommitIsDisabled() throws Exception {
7161
EmbeddedDatabase database = null;
7262
try {

spring-messaging/src/main/java/org/springframework/messaging/simp/SimpMessagingTemplate.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.
@@ -130,8 +130,8 @@ public MessageHeaderInitializer getHeaderInitializer() {
130130
* SimpMessageHeaderAccessor#DESTINATION_HEADER} then the message is sent without
131131
* further changes.
132132
* <p>If a destination header is not already present ,the message is sent
133-
* to the configured {@link #setDefaultDestination(Object) defaultDestination}
134-
* or an exception an {@code IllegalStateException} is raised if that isn't
133+
* to the configured {@link AbstractMessageSendingTemplate#setDefaultDestination(Object)
134+
* defaultDestination} or an {@code IllegalStateException} is raised if that isn't
135135
* configured.
136136
* @param message the message to send (never {@code null})
137137
*/

spring-test/src/test/java/org/springframework/test/context/event/DirtiesContextEventPublishingTests.java

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2002-2022 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.
@@ -49,7 +49,7 @@
4949
*
5050
* @author Sam Brannen
5151
* @since 5.3.17
52-
* @see https://github.com/spring-projects/spring-framework/issues/27757
52+
* @see <a href="https://github.com/spring-projects/spring-framework/issues/27757">gh-27757</a>
5353
*/
5454
class DirtiesContextEventPublishingTests {
5555

spring-test/src/test/java/org/springframework/test/context/event/EagerTestExecutionEventPublishingTests.java

+1-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2002-2022 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.
@@ -50,7 +50,6 @@
5050
*
5151
* @author Sam Brannen
5252
* @since 5.3.17
53-
* @see https://github.com/spring-projects/spring-framework/issues/27757
5453
*/
5554
class EagerTestExecutionEventPublishingTests {
5655

spring-test/src/test/java/org/springframework/test/context/jdbc/PrimaryDataSourceTests.java

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2002-2019 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.
@@ -39,7 +39,7 @@
3939
*
4040
* @author Sam Brannen
4141
* @since 4.3
42-
* @see org.springframework.test.context.transaction.PrimaryTransactionManagerTests
42+
* @see org.springframework.test.context.transaction.manager.PrimaryTransactionManagerTests
4343
*/
4444
@SpringJUnitConfig
4545
@DirtiesContext

spring-test/src/test/java/org/springframework/test/context/junit4/rules/AutowiredRuleTests.java renamed to spring-test/src/test/java/org/springframework/test/context/junit4/rules/AutowiredRuleSpr15927Tests.java

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2002-2019 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.
@@ -30,12 +30,12 @@
3030
import static org.assertj.core.api.Assertions.assertThat;
3131

3232
/**
33-
* Integration tests for an issue raised in https://jira.spring.io/browse/SPR-15927.
33+
* Integration tests for {@code SPR-15927}.
3434
*
3535
* @author Sam Brannen
3636
* @since 5.0
3737
*/
38-
public class AutowiredRuleTests {
38+
public class AutowiredRuleSpr15927Tests {
3939

4040
@ClassRule
4141
public static final SpringClassRule springClassRule = new SpringClassRule();

spring-test/src/test/java/org/springframework/test/context/support/ContextLoaderUtilsContextHierarchyTests.java

+4-15
Original file line numberDiff line numberDiff line change
@@ -327,10 +327,7 @@ void buildContextHierarchyMapForSingleTestClassWithMultiLevelContextHierarchyWit
327327
assertContextConfigEntriesAreNotUnique(SingleTestClassWithMultiLevelContextHierarchyWithDuplicatedContextConfig.class);
328328
}
329329

330-
/**
331-
* Used to reproduce bug reported in https://jira.spring.io/browse/SPR-10997
332-
*/
333-
@Test
330+
@Test // SPR-10997
334331
void buildContextHierarchyMapForTestClassHierarchyWithMultiLevelContextHierarchiesAndOverriddenInitializers() {
335332
Map<String, List<ContextConfigurationAttributes>> map = buildContextHierarchyMap(TestClass2WithMultiLevelContextHierarchyWithOverriddenInitializers.class);
336333

@@ -504,32 +501,24 @@ private static class SingleTestClassWithMultiLevelContextHierarchyWithEmptyConte
504501
private static class SingleTestClassWithMultiLevelContextHierarchyWithDuplicatedContextConfig {
505502
}
506503

507-
/**
508-
* Used to reproduce bug reported in https://jira.spring.io/browse/SPR-10997
509-
*/
510504
@ContextHierarchy({//
511505
//
512506
@ContextConfiguration(name = "alpha", locations = "1-A.xml"),//
513507
@ContextConfiguration(name = "beta", locations = "1-B.xml") //
514-
})
508+
}) // SPR-10997
515509
private static class TestClass1WithMultiLevelContextHierarchyWithUniqueContextConfig {
516510
}
517511

518-
/**
519-
* Used to reproduce bug reported in https://jira.spring.io/browse/SPR-10997
520-
*/
521512
@ContextHierarchy({//
522513
//
523514
@ContextConfiguration(name = "alpha", initializers = DummyApplicationContextInitializer.class),//
524515
@ContextConfiguration(name = "beta", initializers = DummyApplicationContextInitializer.class) //
525-
})
516+
}) // SPR-10997
526517
private static class TestClass2WithMultiLevelContextHierarchyWithOverriddenInitializers extends
527518
TestClass1WithMultiLevelContextHierarchyWithUniqueContextConfig {
528519
}
529520

530-
/**
531-
* Used to reproduce bug reported in https://jira.spring.io/browse/SPR-10997
532-
*/
521+
// SPR-10997
533522
private static class DummyApplicationContextInitializer implements
534523
ApplicationContextInitializer<ConfigurableApplicationContext> {
535524

spring-web/src/jmh/java/org/springframework/web/bind/ServletRequestUtilsBenchmark.java

+4-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2002-2020 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.
@@ -16,6 +16,7 @@
1616

1717
package org.springframework.web.bind;
1818

19+
import jakarta.servlet.ServletRequest;
1920
import org.openjdk.jmh.annotations.Benchmark;
2021
import org.openjdk.jmh.annotations.BenchmarkMode;
2122
import org.openjdk.jmh.annotations.Mode;
@@ -26,7 +27,8 @@
2627

2728

2829
/**
29-
* Benchmarks for extracting parameters from {@libnk ServletRequest}.
30+
* Benchmarks for extracting parameters from {@link ServletRequest}.
31+
*
3032
* @author Brian Clozel
3133
*/
3234
@BenchmarkMode(Mode.Throughput)

spring-web/src/main/java/org/springframework/http/server/reactive/AbstractListenerWriteProcessor.java

+2-3
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2002-2022 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.
@@ -69,8 +69,7 @@ public abstract class AbstractListenerWriteProcessor<T> implements Processor<T,
6969
/**
7070
* Indicates we're waiting for one last isReady-onWritePossible cycle
7171
* after "onComplete" because some Servlet containers expect this to take
72-
* place prior to calling AsyncContext.complete().
73-
* See https://github.com/eclipse-ee4j/servlet-api/issues/273
72+
* place prior to calling AsyncContext.complete(). See also gh-273.
7473
*/
7574
private volatile boolean readyToCompleteAfterLastWrite;
7675

spring-web/src/main/java/org/springframework/web/util/HtmlCharacterEntityReferences.java

+2-2
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.
@@ -31,7 +31,7 @@
3131
* HTML 4.0 standard.
3232
*
3333
* <p>A complete description of the HTML 4.0 character set can be found
34-
* at https://www.w3.org/TR/html4/charset.html.
34+
* at <a href="https://www.w3.org/TR/html4/charset.html">https://www.w3.org/TR/html4/charset.html</a>.
3535
*
3636
* @author Juergen Hoeller
3737
* @author Martin Kersten

spring-web/src/test/java/org/springframework/http/WebBeanUtilsRuntimeHintsTests.java

+2-2
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.
@@ -29,7 +29,7 @@
2929
import static org.assertj.core.api.Assertions.assertThat;
3030

3131
/**
32-
* Web-related tests for {@link BeanUtilsRuntimeHints}.
32+
* Web-related tests for {@link org.springframework.beans.BeanUtilsRuntimeHints}.
3333
*
3434
* @author Sebastien Deleuze
3535
* @since 6.0.10

spring-webmvc/src/main/java/org/springframework/web/servlet/view/document/AbstractPdfView.java

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2002-2018 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.
@@ -138,7 +138,7 @@ protected void prepareWriter(Map<String, Object> model, PdfWriter writer, HttpSe
138138
* The subclass can either have fixed preferences or retrieve
139139
* them from bean properties defined on the View.
140140
* @return an int containing the bits information against PdfWriter definitions
141-
* @see com.lowagie.text.pdf.PdfWriter#AllowPrinting
141+
* @see com.lowagie.text.pdf.PdfWriter#ALLOW_PRINTING
142142
* @see com.lowagie.text.pdf.PdfWriter#PageLayoutSinglePage
143143
*/
144144
protected int getViewerPreferences() {

spring-webmvc/src/test/java/org/springframework/web/servlet/mvc/UrlFilenameViewControllerTests.java

+2-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.
@@ -170,9 +170,8 @@ void settingSuffixToNullCausesEmptyStringToBeUsed() {
170170

171171
/**
172172
* This is the expected behavior, and it now has a test to prove it.
173-
* https://opensource.atlassian.com/projects/spring/browse/SPR-2789
174173
*/
175-
@PathPatternsParameterizedTest
174+
@PathPatternsParameterizedTest // SPR-2789
176175
void nestedPathisUsedAsViewName_InBreakingChangeFromSpring12Line(
177176
Function<String, MockHttpServletRequest> requestFactory) throws Exception {
178177

0 commit comments

Comments
 (0)