Spring/spring-framework
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Fail Gradle build for Javadoc warnings

Browse Source 
In order to catch Javadoc errors in the build, we now enable the
`Xwerror` flag for the `javadoc` tool. In addition, we now use
`Xdoclint:syntax` instead of `Xdoclint:none` in order to validate
syntax within our Javadoc.

This commit fixes all resulting Javadoc errors and warnings.

This commit also upgrades to Undertow 2.2.12.Final and fixes the
artifact names for exclusions for the Servlet and annotations APIs.

The incorrect exclusion of the Servlet API resulted in the Servlet API
being on the classpath twice for the javadoc task, which resulted in the
following warnings in previous builds.

javadoc: warning - Multiple sources of package comments found for package "javax.servlet"
javadoc: warning - Multiple sources of package comments found for package "javax.servlet.http"
javadoc: warning - Multiple sources of package comments found for package "javax.servlet.descriptor"
javadoc: warning - Multiple sources of package comments found for package "javax.servlet.annotation"

Closes gh-27480
This commit is contained in:
Sam Brannen
2021-09-29 14:02:37 +02:00
parent 040445612f
commit 96e4d3a530
81 changed files with 251 additions and 250 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
spring-web/src/main/java/org/springframework/http/ContentDisposition.java
View File

@@ -576,14 +576,13 @@ public final class ContentDisposition {
Builder filename(String filename);
/**
* Set the value of the {@literal filename*} that will be encoded as
* defined in the RFC 5987. Only the US-ASCII, UTF-8 and ISO-8859-1
* Set the value of the {@code filename} that will be encoded as
* defined in RFC 5987. Only the US-ASCII, UTF-8, and ISO-8859-1
* charsets are supported.
* <p><strong>Note:</strong> Do not use this for a
* {@code "multipart/form-data"} requests as per
* <a link="https://tools.ietf.org/html/rfc7578#section-4.2">RFC 7578, Section 4.2</a>
* and also RFC 5987 itself mentions it does not apply to multipart
* requests.
* {@code "multipart/form-data"} request since
* <a href="https://tools.ietf.org/html/rfc7578#section-4.2">RFC 7578, Section 4.2</a>
* and also RFC 5987 mention it does not apply to multipart requests.
*/
Builder filename(String filename, Charset charset);

6
spring-web/src/main/java/org/springframework/http/HttpStatus.java
View File

@@ -285,21 +285,21 @@ public enum HttpStatus {
I_AM_A_TEAPOT(418, Series.CLIENT_ERROR, "I'm a teapot"),
/**
* @deprecated See
* <a href="https://tools.ietf.org/rfcdiff?difftype=--hwdiff{@literal &}url2=draft-ietf-webdav-protocol-06.txt">
* <a href="https://tools.ietf.org/rfcdiff?difftype=--hwdiff&amp;url2=draft-ietf-webdav-protocol-06.txt">
* WebDAV Draft Changes</a>
*/
@Deprecated
INSUFFICIENT_SPACE_ON_RESOURCE(419, Series.CLIENT_ERROR, "Insufficient Space On Resource"),
/**
* @deprecated See
* <a href="https://tools.ietf.org/rfcdiff?difftype=--hwdiff{@literal &}url2=draft-ietf-webdav-protocol-06.txt">
* <a href="https://tools.ietf.org/rfcdiff?difftype=--hwdiff&amp;url2=draft-ietf-webdav-protocol-06.txt">
* WebDAV Draft Changes</a>
*/
@Deprecated
METHOD_FAILURE(420, Series.CLIENT_ERROR, "Method Failure"),
/**
* @deprecated
* See <a href="https://tools.ietf.org/rfcdiff?difftype=--hwdiff{@literal &}url2=draft-ietf-webdav-protocol-06.txt">
* See <a href="https://tools.ietf.org/rfcdiff?difftype=--hwdiff&amp;url2=draft-ietf-webdav-protocol-06.txt">
* WebDAV Draft Changes</a>
*/
@Deprecated

6
spring-web/src/main/java/org/springframework/http/client/ClientHttpRequestInterceptor.java
View File

@@ -42,15 +42,15 @@ public interface ClientHttpRequestInterceptor {
* request and response to the next entity in the chain.
* <p>A typical implementation of this method would follow the following pattern:
* <ol>
* <li>Examine the {@linkplain HttpRequest request} and body</li>
* <li>Examine the {@linkplain HttpRequest request} and body.</li>
* <li>Optionally {@linkplain org.springframework.http.client.support.HttpRequestWrapper
* wrap} the request to filter HTTP attributes.</li>
* <li>Optionally modify the body of the request.</li>
* <li><strong>Either</strong>
* <ul>
* <li><strong>Either</strong>
* <li>execute the request using
* {@link ClientHttpRequestExecution#execute(org.springframework.http.HttpRequest, byte[])},</li>
* <strong>or</strong>
* <li><strong>or</strong></li>
* <li>do not execute the request to block the execution altogether.</li>
* </ul>
* <li>Optionally wrap the response to filter HTTP attributes.</li>

2
spring-web/src/main/java/org/springframework/http/codec/xml/XmlEventDecoder.java
View File

@@ -55,7 +55,7 @@ import org.springframework.util.xml.StaxUtils;
* <p>Given the following XML:
*
* <pre class="code">
* &lt;root>
* &lt;root&gt;
* &lt;child&gt;foo&lt;/child&gt;
* &lt;child&gt;bar&lt;/child&gt;
* &lt;/root&gt;

10
spring-web/src/main/java/org/springframework/http/converter/ObjectToStringHttpMessageConverter.java
View File

@@ -38,11 +38,11 @@ import org.springframework.util.Assert;
* <p>A usage example:
*
* <pre class="code">
* &lt;bean class="org.springframework.http.converter.ObjectToStringHttpMessageConverter">
* &lt;constructor-arg>
* &lt;bean class="org.springframework.context.support.ConversionServiceFactoryBean"/>
* &lt;/constructor-arg>
* &lt;/bean>
* &lt;bean class="org.springframework.http.converter.ObjectToStringHttpMessageConverter"&gt;
* &lt;constructor-arg&gt;
* &lt;bean class="org.springframework.context.support.ConversionServiceFactoryBean"/&gt;
* &lt;/constructor-arg&gt;
* &lt;/bean&gt;
* </pre>
*
* @author <a href="mailto:dmitry.katsubo@gmail.com">Dmitry Katsubo</a>

2
spring-web/src/main/java/org/springframework/http/converter/feed/AtomFeedHttpMessageConverter.java
View File

@@ -25,7 +25,7 @@ import org.springframework.http.MediaType;
* that can read and write Atom feeds. Specifically, this converter can handle {@link Feed}
* objects from the <a href="https://github.com/rometools/rome">ROME</a> project.
*
* <p>><b>NOTE: As of Spring 4.1, this is based on the {@code com.rometools}
* <p><b>NOTE: As of Spring 4.1, this is based on the {@code com.rometools}
* variant of ROME, version 1.5. Please upgrade your build dependency.</b>
*
* <p>By default, this converter reads and writes the media type ({@code application/atom+xml}).

2
spring-web/src/main/java/org/springframework/http/converter/feed/RssChannelHttpMessageConverter.java
View File

@@ -25,7 +25,7 @@ import org.springframework.http.MediaType;
* that can read and write RSS feeds. Specifically, this converter can handle {@link Channel}
* objects from the <a href="https://github.com/rometools/rome">ROME</a> project.
*
* <p>><b>NOTE: As of Spring 4.1, this is based on the {@code com.rometools}
* <p><b>NOTE: As of Spring 4.1, this is based on the {@code com.rometools}
* variant of ROME, version 1.5. Please upgrade your build dependency.</b>
*
* <p>By default, this converter reads and writes the media type ({@code application/rss+xml}).

2
spring-web/src/main/java/org/springframework/remoting/jaxws/SimpleHttpServerJaxWsServiceExporter.java
View File

@@ -135,7 +135,7 @@ public class SimpleHttpServerJaxWsServiceExporter extends AbstractJaxWsServiceEx
* Set the base path for context publication. Default is "/".
* <p>For each context publication path, the service name will be
* appended to this base address. E.g. service name "OrderService"
* -> "/OrderService".
* &rarr; "/OrderService".
* @see javax.xml.ws.Endpoint#publish(Object)
* @see javax.jws.WebService#serviceName()
*/

2
spring-web/src/main/java/org/springframework/remoting/jaxws/SimpleJaxWsServiceExporter.java
View File

@@ -52,7 +52,7 @@ public class SimpleJaxWsServiceExporter extends AbstractJaxWsServiceExporter {
* Default is "http://localhost:8080/".
* <p>For each actual publication address, the service name will be
* appended to this base address. E.g. service name "OrderService"
* -> "http://localhost:8080/OrderService".
* &rarr; "http://localhost:8080/OrderService".
* @see javax.xml.ws.Endpoint#publish(String)
* @see javax.jws.WebService#serviceName()
*/

4
spring-web/src/main/java/org/springframework/web/SpringServletContainerInitializer.java
View File

@@ -61,8 +61,8 @@ import org.springframework.util.ReflectionUtils;
*
* <pre class="code">
* &lt;absolute-ordering&gt;
* &lt;name>some_web_fragment&lt;/name&gt;
* &lt;name>spring_web&lt;/name&gt;
* &lt;name&gt;some_web_fragment&lt;/name&gt;
* &lt;name&gt;spring_web&lt;/name&gt;
* &lt;/absolute-ordering&gt;
* </pre>
*

10
spring-web/src/main/java/org/springframework/web/WebApplicationInitializer.java
View File

@@ -36,15 +36,15 @@ import javax.servlet.ServletException;
* follows:
* <pre class="code">
* &lt;servlet&gt;
* &lt;servlet-name>dispatcher&lt;/servlet-name&gt;
* &lt;servlet-name&gt;dispatcher&lt;/servlet-name&gt;
* &lt;servlet-class&gt;
* org.springframework.web.servlet.DispatcherServlet
* &lt;/servlet-class&gt;
* &lt;init-param>
* &lt;param-name>contextConfigLocation&lt;/param-name&gt;
* &lt;param-value>/WEB-INF/spring/dispatcher-config.xml&lt;/param-value&gt;
* &lt;init-param&gt;
* &lt;param-name&gt;contextConfigLocation&lt;/param-name&gt;
* &lt;param-value&gt;/WEB-INF/spring/dispatcher-config.xml&lt;/param-value&gt;
* &lt;/init-param&gt;
* &lt;load-on-startup>1&lt;/load-on-startup&gt;
* &lt;load-on-startup&gt;1&lt;/load-on-startup&gt;
* &lt;/servlet&gt;
*
* &lt;servlet-mapping&gt;

28
spring-web/src/main/java/org/springframework/web/jsf/el/SpringBeanFacesELResolver.java
View File

@@ -36,33 +36,33 @@ import org.springframework.web.jsf.FacesContextUtils;
* <p>Configure this resolver in your {@code faces-config.xml} file as follows:
*
* <pre class="code">
* &lt;application>
* &lt;application&gt;
* ...
* &lt;el-resolver>org.springframework.web.jsf.el.SpringBeanFacesELResolver&lt;/el-resolver>
* &lt;/application></pre>
* &lt;el-resolver&gt;org.springframework.web.jsf.el.SpringBeanFacesELResolver&lt;/el-resolver&gt;
* &lt;/application&gt;</pre>
*
* All your JSF expressions can then implicitly refer to the names of
* Spring-managed service layer beans, for example in property values of
* JSF-managed beans:
*
* <pre class="code">
* &lt;managed-bean>
* &lt;managed-bean-name>myJsfManagedBean&lt;/managed-bean-name>
* &lt;managed-bean-class>example.MyJsfManagedBean&lt;/managed-bean-class>
* &lt;managed-bean-scope>session&lt;/managed-bean-scope>
* &lt;managed-property>
* &lt;property-name>mySpringManagedBusinessObject&lt;/property-name>
* &lt;value>#{mySpringManagedBusinessObject}&lt;/value>
* &lt;/managed-property>
* &lt;/managed-bean></pre>
* &lt;managed-bean&gt;
* &lt;managed-bean-name&gt;myJsfManagedBean&lt;/managed-bean-name&gt;
* &lt;managed-bean-class&gt;example.MyJsfManagedBean&lt;/managed-bean-class&gt;
* &lt;managed-bean-scope&gt;session&lt;/managed-bean-scope&gt;
* &lt;managed-property&gt;
* &lt;property-name&gt;mySpringManagedBusinessObject&lt;/property-name&gt;
* &lt;value&gt;#{mySpringManagedBusinessObject}&lt;/value&gt;
* &lt;/managed-property&gt;
* &lt;/managed-bean&gt;</pre>
*
* with "mySpringManagedBusinessObject" defined as Spring bean in
* applicationContext.xml:
*
* <pre class="code">
* &lt;bean id="mySpringManagedBusinessObject" class="example.MySpringManagedBusinessObject">
* &lt;bean id="mySpringManagedBusinessObject" class="example.MySpringManagedBusinessObject"&gt;
* ...
* &lt;/bean></pre>
* &lt;/bean&gt;</pre>
*
* @author Juergen Hoeller
* @since 2.5

6
spring-web/src/main/java/org/springframework/web/jsf/el/WebApplicationContextFacesELResolver.java
View File

@@ -45,10 +45,10 @@ import org.springframework.web.jsf.FacesContextUtils;
* <p>Configure this resolver in your {@code faces-config.xml} file as follows:
*
* <pre class="code">
* &lt;application>
* &lt;application&gt;
* ...
* &lt;el-resolver>org.springframework.web.jsf.el.WebApplicationContextFacesELResolver&lt;/el-resolver>
* &lt;/application></pre>
* &lt;el-resolver&gt;org.springframework.web.jsf.el.WebApplicationContextFacesELResolver&lt;/el-resolver&gt;
* &lt;/application&gt;</pre>
*
* @author Juergen Hoeller
* @since 2.5

2
spring-web/src/main/java/org/springframework/web/server/ServerWebExchange.java
View File

@@ -248,7 +248,7 @@ public interface ServerWebExchange {
* Configure a consumer to modify the current request using a builder.
* <p>Effectively this:
* <pre>
* exchange.mutate().request(builder-> builder.method(HttpMethod.PUT));
* exchange.mutate().request(builder -&gt; builder.method(HttpMethod.PUT));
*
* // vs...
*

10
spring-web/src/main/java/org/springframework/web/util/UrlPathHelper.java
View File

@@ -290,11 +290,11 @@ public class UrlPathHelper {
* i.e. the part of the request's URL beyond the part that called the servlet,
* or "" if the whole URL has been used to identify the servlet.
* <p>Detects include request URL if called within a RequestDispatcher include.
* <p>E.g.: servlet mapping = "/*"; request URI = "/test/a" -> "/test/a".
* <p>E.g.: servlet mapping = "/"; request URI = "/test/a" -> "/test/a".
* <p>E.g.: servlet mapping = "/test/*"; request URI = "/test/a" -> "/a".
* <p>E.g.: servlet mapping = "/test"; request URI = "/test" -> "".
* <p>E.g.: servlet mapping = "/*.test"; request URI = "/a.test" -> "".
* <p>E.g.: servlet mapping = "/*"; request URI = "/test/a" &rarr; "/test/a".
* <p>E.g.: servlet mapping = "/"; request URI = "/test/a" &rarr; "/test/a".
* <p>E.g.: servlet mapping = "/test/*"; request URI = "/test/a" &rarr; "/a".
* <p>E.g.: servlet mapping = "/test"; request URI = "/test" &rarr; "".
* <p>E.g.: servlet mapping = "/*.test"; request URI = "/a.test" &rarr; "".
* @param request current HTTP request
* @param pathWithinApp a precomputed path within the application
* @return the path within the servlet mapping, or ""