Improve how the build deals with javadoc invalid references

This commit improves how the build deals with javadoc invalid references
in two ways.

Link/see references that are temporarily invalid during javadoc
generation of individual modules are better masked by using the option
`Xdoclint:syntax` instead of `Xdoclint:none` (warnings were still
visible in some cases, e.g. when individually building the javadoc for
a specific module).

Global javadoc-building task `api` now combines `syntax` and `reference`
`Xdoclint` groups, allowing to raise truly invalid references even when
all the modules have been aggregated.

This commit also fixes the 20+ errors which appeared following the later
change in doclet configuration.

Closes gh-30428
This commit is contained in:
Simon Baslé
2023-05-04 18:20:43 +02:00
parent 280b0de646
commit eabb846d07
18 changed files with 26 additions and 27 deletions

View File

@@ -81,7 +81,6 @@ public interface CacheAwareContextLoaderDelegate {
* the application context
* @see #isContextLoaded
* @see #closeContext
* @see #setContextFailureProcessor
*/
ApplicationContext loadContext(MergedContextConfiguration mergedContextConfiguration);

View File

@@ -66,7 +66,7 @@ import org.springframework.util.ObjectUtils;
* example, {@link ContextConfiguration#inheritLocations}.
*
* @author Sam Brannen
* @since 5.3, though originally since 4.0 as {@link org.springframework.test.util.MetaAnnotationUtils}
* @since 5.3, though originally since 4.0 as {@code org.springframework.test.util.MetaAnnotationUtils}
* @see AnnotationUtils
* @see AnnotatedElementUtils
* @see AnnotationDescriptor

View File

@@ -494,13 +494,13 @@ public abstract class AbstractTestContextBootstrapper implements TestContextBoot
* interaction with the {@code ContextCache}.
* <p>The default implementation delegates to
* {@code getBootstrapContext().getCacheAwareContextLoaderDelegate()} and
* supplies the returned delegate the configured
* {@link #getApplicationContextFailureProcessor() ApplicationContextFailureProcessor}.
* the default one will load {@link org.springframework.test.context.ApplicationContextFailureProcessor}
* via the service loading mechanism.
* <p>Concrete subclasses may choose to override this method to return a custom
* {@code CacheAwareContextLoaderDelegate} implementation with custom
* {@link org.springframework.test.context.cache.ContextCache ContextCache} support.
* @return the context loader delegate (never {@code null})
* @see #getApplicationContextFailureProcessor()
* @see org.springframework.test.context.ApplicationContextFailureProcessor
*/
protected CacheAwareContextLoaderDelegate getCacheAwareContextLoaderDelegate() {
return getBootstrapContext().getCacheAwareContextLoaderDelegate();

View File

@@ -28,7 +28,7 @@ import org.springframework.util.Assert;
* Simple utility for finding available TCP ports on {@code localhost} for use in
* integration testing scenarios.
*
* <p>This is a limited form of {@link org.springframework.util.SocketUtils} which
* <p>This is a limited form of {@code org.springframework.util.SocketUtils}, which
* has been deprecated since Spring Framework 5.3.16 and removed in Spring
* Framework 6.0.
*

View File

@@ -110,7 +110,7 @@ public abstract class AbstractRequestExpectationManager implements RequestExpect
/**
* As of 5.0.3 subclasses should implement this method instead of
* {@link #validateRequestInternal(ClientHttpRequest)} in order to match the
* {@code #validateRequestInternal(ClientHttpRequest)} in order to match the
* request to an expectation, leaving the call to create the response as a separate step
* (to be invoked by this class).
* @param request the current request