Skip to content

Commit

Permalink
Fix Javadoc
Browse files Browse the repository at this point in the history
This commit fixes various Javadoc issues across the code base.

See gh-32403
  • Loading branch information
qeeqez authored and snicoll committed Mar 9, 2024
1 parent c1287d4 commit abdccff
Show file tree
Hide file tree
Showing 22 changed files with 51 additions and 51 deletions.
Original file line number Diff line number Diff line change
@@ -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.
Expand Down Expand Up @@ -45,7 +45,7 @@ public void unlock() {
}

/**
* @see test.mixin.AopProxyTests.Lockable#locked()
* @see org.springframework.aop.testfixture.mixin.Lockable#locked()
*/
@Override
public boolean locked() {
Expand All @@ -57,7 +57,7 @@ public boolean locked() {
* 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.MethodInterceptor#invoke(org.aopalliance.MethodInvocation)
* @see org.aopalliance.intercept.MethodInterceptor#invoke(MethodInvocation)
*/
@Override
public Object invoke(MethodInvocation invocation) throws Throwable {
Expand Down
Original file line number Diff line number Diff line change
@@ -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.
Expand Down Expand Up @@ -33,9 +33,9 @@ record MethodDescriptor(Class<?> declaringClass, String methodName, Class<?>...

/**
* Create a {@link MethodDescriptor} for the supplied bean class and method name.
* <p>The supplied {@code methodName} may be a {@linkplain Method#getName()
* <p>The supplied {@code methodName} may be a {@linkplain java.lang.reflect.Method#getName()
* simple method name} or a
* {@linkplain org.springframework.util.ClassUtils#getQualifiedMethodName(Method)
* {@linkplain org.springframework.util.ClassUtils#getQualifiedMethodName(java.lang.reflect.Method)
* qualified method name}.
* <p>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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -554,7 +554,7 @@ class C {
* 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 https://bugs.java.com/bugdatabase/view_bug.do?bug_id=7023180
* @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>
* @see #cornerSpr9702()
*/
@Test
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -266,9 +266,9 @@ private static Method searchForMatch(Class<?> type, Method bridgeMethod) {
/**
* 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 https://bugs.openjdk.org/browse/JDK-6342411.
* See also https://stas-blogspot.blogspot.com/2010/03/java-bridge-methods-explained.html
* introduced in Java 6 to fix <a href="https://bugs.openjdk.org/browse/JDK-6342411">JDK-6342411</a>.
* @return whether signatures match as described
* @see <a href="https://stas-blogspot.blogspot.com/2010/03/java-bridge-methods-explained.html">Java bridge methods explained</a>
*/
public static boolean isVisibilityBridgeMethodPair(Method bridgeMethod, Method bridgedMethod) {
if (bridgeMethod == bridgedMethod) {
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright 2002-2022 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.
Expand Down Expand Up @@ -39,7 +39,7 @@
*
* @author Sam Brannen
* @since 5.3.24
* @see https://github.com/spring-projects/spring-framework/issues/20279
* @see <a href="https://github.com/spring-projects/spring-framework/issues/20279">gh-20279</a>
*/
@SuppressWarnings("unused")
class NestedRepeatableAnnotationsTests {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -163,8 +163,8 @@ private TypedValue executeFunctionViaMethod(ExpressionState state, Method method
/**
* Execute a function represented as {@link MethodHandle}.
* <p>Method types that take no arguments (fully bound handles or static methods
* with no parameters) can use {@link MethodHandle#invoke()} which is the most
* efficient. Otherwise, {@link MethodHandle#invokeWithArguments()} is used.
* with no parameters) can use {@link MethodHandle#invoke(Object... var1)} which is the most
* efficient. Otherwise, {@link MethodHandle#invokeWithArguments(Object... arguments)} is used.
* @param state the expression evaluation state
* @param methodHandle the method handle to invoke
* @return the return value of the invoked Java method
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@

///CLOVER:OFF
/**
* Spring Security scenarios from https://docs.spring.io/spring-security/reference/servlet/authorization/expression-based.html
* 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>
*
* @author Andy Clement
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ protected EmbeddedDatabaseType getEmbeddedDatabaseType() {
}

/**
* https://jira.spring.io/browse/SPR-15896
* <a href="https://jira.spring.io/browse/SPR-15896">SPR-15896</a>
*
* @since 5.0
*/
Expand All @@ -62,7 +62,7 @@ void scriptWithH2Alias() {
}

/**
* https://github.com/spring-projects/spring-framework/issues/27008
* <a href="https://github.com/spring-projects/spring-framework/issues/27008">gh-27008</a>
*
* @since 5.3.11
*/
Expand Down
Original file line number Diff line number Diff line change
@@ -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.
Expand Down Expand Up @@ -130,7 +130,7 @@ public MessageHeaderInitializer getHeaderInitializer() {
* SimpMessageHeaderAccessor#DESTINATION_HEADER} then the message is sent without
* further changes.
* <p>If a destination header is not already present ,the message is sent
* to the configured {@link #setDefaultDestination(Object) defaultDestination}
* to the configured {@link AbstractMessageSendingTemplate#setDefaultDestination(Object) defaultDestination}
* or an exception an {@code IllegalStateException} is raised if that isn't
* configured.
* @param message the message to send (never {@code null})
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright 2002-2022 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.
Expand Down Expand Up @@ -49,7 +49,7 @@
*
* @author Sam Brannen
* @since 5.3.17
* @see https://github.com/spring-projects/spring-framework/issues/27757
* @see <a href="https://github.com/spring-projects/spring-framework/issues/27757">gh-27757</a>
*/
class DirtiesContextEventPublishingTests {

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright 2002-2022 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.
Expand Down Expand Up @@ -50,7 +50,7 @@
*
* @author Sam Brannen
* @since 5.3.17
* @see https://github.com/spring-projects/spring-framework/issues/27757
* @see <a href="https://github.com/spring-projects/spring-framework/issues/27757">gh-27757</a>
*/
class EagerTestExecutionEventPublishingTests {

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright 2002-2019 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.
Expand Down Expand Up @@ -39,7 +39,7 @@
*
* @author Sam Brannen
* @since 4.3
* @see org.springframework.test.context.transaction.PrimaryTransactionManagerTests
* @see org.springframework.test.context.transaction.manager.PrimaryTransactionManagerTests
*/
@SpringJUnitConfig
@DirtiesContext
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright 2002-2019 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.
Expand Down Expand Up @@ -30,7 +30,7 @@
import static org.assertj.core.api.Assertions.assertThat;

/**
* Integration tests for an issue raised in https://jira.spring.io/browse/SPR-15927.
* Integration tests for an issue raised in <a href="https://jira.spring.io/browse/SPR-15927">SPR-15927</a>.
*
* @author Sam Brannen
* @since 5.0
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -328,7 +328,7 @@ void buildContextHierarchyMapForSingleTestClassWithMultiLevelContextHierarchyWit
}

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

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

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

/**
* Used to reproduce bug reported in https://jira.spring.io/browse/SPR-10997
* Used to reproduce bug reported in <a href="https://jira.spring.io/browse/SPR-10997">SPR-10997</a>
*/
private static class DummyApplicationContextInitializer implements
ApplicationContextInitializer<ConfigurableApplicationContext> {
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright 2002-2020 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.
Expand All @@ -26,7 +26,7 @@


/**
* Benchmarks for extracting parameters from {@libnk ServletRequest}.
* Benchmarks for extracting parameters from {@link jakarta.servlet.ServletRequest}.
* @author Brian Clozel
*/
@BenchmarkMode(Mode.Throughput)
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright 2002-2022 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.
Expand Down Expand Up @@ -70,7 +70,7 @@ public abstract class AbstractListenerWriteProcessor<T> implements Processor<T,
* Indicates we're waiting for one last isReady-onWritePossible cycle
* after "onComplete" because some Servlet containers expect this to take
* place prior to calling AsyncContext.complete().
* See https://github.com/eclipse-ee4j/servlet-api/issues/273
* @see <a href="https://github.com/eclipse-ee4j/servlet-api/issues/273">gh-273</a>
*/
private volatile boolean readyToCompleteAfterLastWrite;

Expand Down
Original file line number Diff line number Diff line change
@@ -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.
Expand Down Expand Up @@ -31,7 +31,7 @@
* HTML 4.0 standard.
*
* <p>A complete description of the HTML 4.0 character set can be found
* at https://www.w3.org/TR/html4/charset.html.
* at <a href="https://www.w3.org/TR/html4/charset.html">https://www.w3.org/TR/html4/charset.html</a>.
*
* @author Juergen Hoeller
* @author Martin Kersten
Expand Down
Original file line number Diff line number Diff line change
@@ -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.
Expand Down Expand Up @@ -29,7 +29,7 @@
import static org.assertj.core.api.Assertions.assertThat;

/**
* Web-related tests for {@link BeanUtilsRuntimeHints}.
* Web-related tests for {@link org.springframework.beans.BeanUtilsRuntimeHints}.
*
* @author Sebastien Deleuze
* @since 6.0.10
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright 2002-2018 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.
Expand Down Expand Up @@ -138,7 +138,7 @@ protected void prepareWriter(Map<String, Object> model, PdfWriter writer, HttpSe
* The subclass can either have fixed preferences or retrieve
* them from bean properties defined on the View.
* @return an int containing the bits information against PdfWriter definitions
* @see com.lowagie.text.pdf.PdfWriter#AllowPrinting
* @see com.lowagie.text.pdf.PdfWriter#ALLOW_PRINTING
* @see com.lowagie.text.pdf.PdfWriter#PageLayoutSinglePage
*/
protected int getViewerPreferences() {
Expand Down
Original file line number Diff line number Diff line change
@@ -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.
Expand Down Expand Up @@ -170,7 +170,7 @@ void settingSuffixToNullCausesEmptyStringToBeUsed() {

/**
* This is the expected behavior, and it now has a test to prove it.
* https://opensource.atlassian.com/projects/spring/browse/SPR-2789
* @see <a href="https://opensource.atlassian.com/projects/spring/browse/SPR-2789">SPR-2789</a>
*/
@PathPatternsParameterizedTest
void nestedPathisUsedAsViewName_InBreakingChangeFromSpring12Line(
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -356,7 +356,7 @@ void asBodyTagWithExistingMessagesAttribute() throws Exception {
}

/**
* https://jira.spring.io/browse/SPR-2788
* <a href="https://jira.spring.io/browse/SPR-2788">SPR-2788</a>
*/
@Test
void asBodyTagWithErrorsAndExistingMessagesAttributeInNonPageScopeAreNotClobbered() throws Exception {
Expand All @@ -380,39 +380,39 @@ void asBodyTagWithErrorsAndExistingMessagesAttributeInNonPageScopeAreNotClobbere
}

/**
* https://jira.spring.io/browse/SPR-2788
* <a href="https://jira.spring.io/browse/SPR-2788">SPR-2788</a>
*/
@Test
void asBodyTagWithNoErrorsAndExistingMessagesAttributeInApplicationScopeAreNotClobbered() throws Exception {
assertWhenNoErrorsExistingMessagesInScopeAreNotClobbered(PageContext.APPLICATION_SCOPE);
}

/**
* https://jira.spring.io/browse/SPR-2788
* <a href="https://jira.spring.io/browse/SPR-2788">SPR-2788</a>
*/
@Test
void asBodyTagWithNoErrorsAndExistingMessagesAttributeInSessionScopeAreNotClobbered() throws Exception {
assertWhenNoErrorsExistingMessagesInScopeAreNotClobbered(PageContext.SESSION_SCOPE);
}

/**
* https://jira.spring.io/browse/SPR-2788
* <a href="https://jira.spring.io/browse/SPR-2788">SPR-2788</a>
*/
@Test
void asBodyTagWithNoErrorsAndExistingMessagesAttributeInPageScopeAreNotClobbered() throws Exception {
assertWhenNoErrorsExistingMessagesInScopeAreNotClobbered(PageContext.PAGE_SCOPE);
}

/**
* https://jira.spring.io/browse/SPR-2788
* <a href="https://jira.spring.io/browse/SPR-2788">SPR-2788</a>
*/
@Test
void asBodyTagWithNoErrorsAndExistingMessagesAttributeInRequestScopeAreNotClobbered() throws Exception {
assertWhenNoErrorsExistingMessagesInScopeAreNotClobbered(PageContext.REQUEST_SCOPE);
}

/**
* https://jira.spring.io/browse/SPR-4005
* <a href="https://jira.spring.io/browse/SPR-4005">SPR-4005</a>
*/
@Test
void omittedPathMatchesObjectErrorsOnly() throws Exception {
Expand Down

0 comments on commit abdccff

Please sign in to comment.