Skip to content

Commit abdccff

Browse files
theqeeqezsnicoll
authored andcommitted
Fix Javadoc
This commit fixes various Javadoc issues across the code base. See gh-32403
1 parent c1287d4 commit abdccff

File tree

22 files changed

+51
-51
lines changed

22 files changed

+51
-51
lines changed

spring-aop/src/testFixtures/java/org/springframework/aop/testfixture/mixin/LockMixin.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.
@@ -45,7 +45,7 @@ public void unlock() {
4545
}
4646

4747
/**
48-
* @see test.mixin.AopProxyTests.Lockable#locked()
48+
* @see org.springframework.aop.testfixture.mixin.Lockable#locked()
4949
*/
5050
@Override
5151
public boolean locked() {
@@ -57,7 +57,7 @@ public boolean locked() {
5757
* If the method is a setter and we're locked, prevent execution.
5858
* Otherwise let super.invoke() handle it, and do normal
5959
* Lockable(this) then target behaviour.
60-
* @see org.aopalliance.MethodInterceptor#invoke(org.aopalliance.MethodInvocation)
60+
* @see org.aopalliance.intercept.MethodInterceptor#invoke(MethodInvocation)
6161
*/
6262
@Override
6363
public Object invoke(MethodInvocation invocation) throws Throwable {

spring-beans/src/main/java/org/springframework/beans/factory/support/MethodDescriptor.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.
@@ -33,9 +33,9 @@ record MethodDescriptor(Class<?> declaringClass, String methodName, Class<?>...
3333

3434
/**
3535
* Create a {@link MethodDescriptor} for the supplied bean class and method name.
36-
* <p>The supplied {@code methodName} may be a {@linkplain Method#getName()
36+
* <p>The supplied {@code methodName} may be a {@linkplain java.lang.reflect.Method#getName()
3737
* simple method name} or a
38-
* {@linkplain org.springframework.util.ClassUtils#getQualifiedMethodName(Method)
38+
* {@linkplain org.springframework.util.ClassUtils#getQualifiedMethodName(java.lang.reflect.Method)
3939
* qualified method name}.
4040
* <p>If the method name is fully qualified, this utility will parse the
4141
* 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 : Change in specified-to-be-unspecified ordering of getDeclaredMethods causes application problems</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,9 +266,9 @@ 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">JDK-6342411</a>.
271270
* @return whether signatures match as described
271+
* @see <a href="https://stas-blogspot.blogspot.com/2010/03/java-bridge-methods-explained.html">Java bridge methods explained</a>
272272
*/
273273
public static boolean isVisibilityBridgeMethodPair(Method bridgeMethod, Method bridgedMethod) {
274274
if (bridgeMethod == bridgedMethod) {

spring-core/src/test/java/org/springframework/core/annotation/NestedRepeatableAnnotationsTests.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.
@@ -39,7 +39,7 @@
3939
*
4040
* @author Sam Brannen
4141
* @since 5.3.24
42-
* @see https://github.com/spring-projects/spring-framework/issues/20279
42+
* @see <a href="https://github.com/spring-projects/spring-framework/issues/20279">gh-20279</a>
4343
*/
4444
@SuppressWarnings("unused")
4545
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... var1)} which is the most
167+
* efficient. Otherwise, {@link MethodHandle#invokeWithArguments(Object... arguments)} 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

+1-1
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@
3939

4040
///CLOVER:OFF
4141
/**
42-
* Spring Security scenarios from https://docs.spring.io/spring-security/reference/servlet/authorization/expression-based.html
42+
* Spring Security scenarios from <a href="https://docs.spring.io/spring-security/reference/servlet/authorization/authorize-http-requests.html#authorization-expressions">Expressing Authorization with SpEL</a>
4343
*
4444
* @author Andy Clement
4545
*/

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

+2-2
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ protected EmbeddedDatabaseType getEmbeddedDatabaseType() {
4444
}
4545

4646
/**
47-
* https://jira.spring.io/browse/SPR-15896
47+
* <a href="https://jira.spring.io/browse/SPR-15896">SPR-15896</a>
4848
*
4949
* @since 5.0
5050
*/
@@ -62,7 +62,7 @@ void scriptWithH2Alias() {
6262
}
6363

6464
/**
65-
* https://github.com/spring-projects/spring-framework/issues/27008
65+
* <a href="https://github.com/spring-projects/spring-framework/issues/27008">gh-27008</a>
6666
*
6767
* @since 5.3.11
6868
*/

spring-messaging/src/main/java/org/springframework/messaging/simp/SimpMessagingTemplate.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.
@@ -130,7 +130,7 @@ 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}
133+
* to the configured {@link AbstractMessageSendingTemplate#setDefaultDestination(Object) defaultDestination}
134134
* or an exception an {@code IllegalStateException} is raised if that isn't
135135
* configured.
136136
* @param message the message to send (never {@code null})

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

+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.
@@ -50,7 +50,7 @@
5050
*
5151
* @author Sam Brannen
5252
* @since 5.3.17
53-
* @see https://github.com/spring-projects/spring-framework/issues/27757
53+
* @see <a href="https://github.com/spring-projects/spring-framework/issues/27757">gh-27757</a>
5454
*/
5555
class EagerTestExecutionEventPublishingTests {
5656

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

+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.
@@ -30,7 +30,7 @@
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 an issue raised in <a href="https://jira.spring.io/browse/SPR-15927">SPR-15927</a>.
3434
*
3535
* @author Sam Brannen
3636
* @since 5.0

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

+4-4
Original file line numberDiff line numberDiff line change
@@ -328,7 +328,7 @@ void buildContextHierarchyMapForSingleTestClassWithMultiLevelContextHierarchyWit
328328
}
329329

330330
/**
331-
* Used to reproduce bug reported in https://jira.spring.io/browse/SPR-10997
331+
* Used to reproduce bug reported in <a href="https://jira.spring.io/browse/SPR-10997">SPR-10997</a>
332332
*/
333333
@Test
334334
void buildContextHierarchyMapForTestClassHierarchyWithMultiLevelContextHierarchiesAndOverriddenInitializers() {
@@ -505,7 +505,7 @@ private static class SingleTestClassWithMultiLevelContextHierarchyWithDuplicated
505505
}
506506

507507
/**
508-
* Used to reproduce bug reported in https://jira.spring.io/browse/SPR-10997
508+
* Used to reproduce bug reported in <a href="https://jira.spring.io/browse/SPR-10997">SPR-10997</a>
509509
*/
510510
@ContextHierarchy({//
511511
//
@@ -516,7 +516,7 @@ private static class TestClass1WithMultiLevelContextHierarchyWithUniqueContextCo
516516
}
517517

518518
/**
519-
* Used to reproduce bug reported in https://jira.spring.io/browse/SPR-10997
519+
* Used to reproduce bug reported in <a href="https://jira.spring.io/browse/SPR-10997">SPR-10997</a>
520520
*/
521521
@ContextHierarchy({//
522522
//
@@ -528,7 +528,7 @@ private static class TestClass2WithMultiLevelContextHierarchyWithOverriddenIniti
528528
}
529529

530530
/**
531-
* Used to reproduce bug reported in https://jira.spring.io/browse/SPR-10997
531+
* Used to reproduce bug reported in <a href="https://jira.spring.io/browse/SPR-10997">SPR-10997</a>
532532
*/
533533
private static class DummyApplicationContextInitializer implements
534534
ApplicationContextInitializer<ConfigurableApplicationContext> {

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

+2-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.
@@ -26,7 +26,7 @@
2626

2727

2828
/**
29-
* Benchmarks for extracting parameters from {@libnk ServletRequest}.
29+
* Benchmarks for extracting parameters from {@link jakarta.servlet.ServletRequest}.
3030
* @author Brian Clozel
3131
*/
3232
@BenchmarkMode(Mode.Throughput)

spring-web/src/main/java/org/springframework/http/server/reactive/AbstractListenerWriteProcessor.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.
@@ -70,7 +70,7 @@ public abstract class AbstractListenerWriteProcessor<T> implements Processor<T,
7070
* Indicates we're waiting for one last isReady-onWritePossible cycle
7171
* after "onComplete" because some Servlet containers expect this to take
7272
* place prior to calling AsyncContext.complete().
73-
* See https://github.com/eclipse-ee4j/servlet-api/issues/273
73+
* @see <a href="https://github.com/eclipse-ee4j/servlet-api/issues/273">gh-273</a>
7474
*/
7575
private volatile boolean readyToCompleteAfterLastWrite;
7676

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-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.
@@ -170,7 +170,7 @@ 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
173+
* @see <a href="https://opensource.atlassian.com/projects/spring/browse/SPR-2789">SPR-2789</a>
174174
*/
175175
@PathPatternsParameterizedTest
176176
void nestedPathisUsedAsViewName_InBreakingChangeFromSpring12Line(

spring-webmvc/src/test/java/org/springframework/web/servlet/tags/form/ErrorsTagTests.java

+6-6
Original file line numberDiff line numberDiff line change
@@ -356,7 +356,7 @@ void asBodyTagWithExistingMessagesAttribute() throws Exception {
356356
}
357357

358358
/**
359-
* https://jira.spring.io/browse/SPR-2788
359+
* <a href="https://jira.spring.io/browse/SPR-2788">SPR-2788</a>
360360
*/
361361
@Test
362362
void asBodyTagWithErrorsAndExistingMessagesAttributeInNonPageScopeAreNotClobbered() throws Exception {
@@ -380,39 +380,39 @@ void asBodyTagWithErrorsAndExistingMessagesAttributeInNonPageScopeAreNotClobbere
380380
}
381381

382382
/**
383-
* https://jira.spring.io/browse/SPR-2788
383+
* <a href="https://jira.spring.io/browse/SPR-2788">SPR-2788</a>
384384
*/
385385
@Test
386386
void asBodyTagWithNoErrorsAndExistingMessagesAttributeInApplicationScopeAreNotClobbered() throws Exception {
387387
assertWhenNoErrorsExistingMessagesInScopeAreNotClobbered(PageContext.APPLICATION_SCOPE);
388388
}
389389

390390
/**
391-
* https://jira.spring.io/browse/SPR-2788
391+
* <a href="https://jira.spring.io/browse/SPR-2788">SPR-2788</a>
392392
*/
393393
@Test
394394
void asBodyTagWithNoErrorsAndExistingMessagesAttributeInSessionScopeAreNotClobbered() throws Exception {
395395
assertWhenNoErrorsExistingMessagesInScopeAreNotClobbered(PageContext.SESSION_SCOPE);
396396
}
397397

398398
/**
399-
* https://jira.spring.io/browse/SPR-2788
399+
* <a href="https://jira.spring.io/browse/SPR-2788">SPR-2788</a>
400400
*/
401401
@Test
402402
void asBodyTagWithNoErrorsAndExistingMessagesAttributeInPageScopeAreNotClobbered() throws Exception {
403403
assertWhenNoErrorsExistingMessagesInScopeAreNotClobbered(PageContext.PAGE_SCOPE);
404404
}
405405

406406
/**
407-
* https://jira.spring.io/browse/SPR-2788
407+
* <a href="https://jira.spring.io/browse/SPR-2788">SPR-2788</a>
408408
*/
409409
@Test
410410
void asBodyTagWithNoErrorsAndExistingMessagesAttributeInRequestScopeAreNotClobbered() throws Exception {
411411
assertWhenNoErrorsExistingMessagesInScopeAreNotClobbered(PageContext.REQUEST_SCOPE);
412412
}
413413

414414
/**
415-
* https://jira.spring.io/browse/SPR-4005
415+
* <a href="https://jira.spring.io/browse/SPR-4005">SPR-4005</a>
416416
*/
417417
@Test
418418
void omittedPathMatchesObjectErrorsOnly() throws Exception {

0 commit comments

Comments
 (0)