Fix Javadoc errors

See gh-27480
2021-09-28 11:43:40 +02:00
parent 2567b20949
commit bfdc99ab79
28 changed files with 120 additions and 120 deletions
--- a/spring-web/src/main/java/org/springframework/http/HttpStatus.java
+++ b/spring-web/src/main/java/org/springframework/http/HttpStatus.java
@@ -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&url2=draft-ietf-webdav-protocol-06.txt">
+	 * <a href="https://tools.ietf.org/rfcdiff?difftype=--hwdiff{@literal &}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&url2=draft-ietf-webdav-protocol-06.txt">
+	 * <a href="https://tools.ietf.org/rfcdiff?difftype=--hwdiff{@literal &}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&url2=draft-ietf-webdav-protocol-06.txt">
+	 * See <a href="https://tools.ietf.org/rfcdiff?difftype=--hwdiff{@literal &}url2=draft-ietf-webdav-protocol-06.txt">
 	 *     WebDAV Draft Changes</a>
 	 */
 	@Deprecated
--- a/spring-web/src/main/java/org/springframework/http/converter/json/Jackson2ObjectMapperBuilder.java
+++ b/spring-web/src/main/java/org/springframework/http/converter/json/Jackson2ObjectMapperBuilder.java
@@ -83,7 +83,7 @@ import org.springframework.util.xml.StaxUtils;
 * <li><a href="https://github.com/FasterXML/jackson-datatype-jdk8">jackson-datatype-jdk8</a>:
 * support for other Java 8 types like {@link java.util.Optional}</li>
 * <li><a href="https://github.com/FasterXML/jackson-datatype-jsr310">jackson-datatype-jsr310</a>:
- * support for Java 8 Date & Time API types</li>
+ * support for Java 8 Date &amp; Time API types</li>
 * <li><a href="https://github.com/FasterXML/jackson-datatype-joda">jackson-datatype-joda</a>:
 * support for Joda-Time types</li>
 * <li><a href="https://github.com/FasterXML/jackson-module-kotlin">jackson-module-kotlin</a>:
--- a/spring-web/src/main/java/org/springframework/http/converter/json/Jackson2ObjectMapperFactoryBean.java
+++ b/spring-web/src/main/java/org/springframework/http/converter/json/Jackson2ObjectMapperFactoryBean.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2020 the original author or authors.
+ * Copyright 2002-2021 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.
@@ -62,54 +62,54 @@ import org.springframework.lang.Nullable;
 * <p>Example usage with
 * {@link MappingJackson2HttpMessageConverter}:
 *
- * <pre class="code">
- * &lt;bean class="org.springframework.http.converter.json.MappingJackson2HttpMessageConverter">
- *   &lt;property name="objectMapper">
- *     &lt;bean class="org.springframework.http.converter.json.Jackson2ObjectMapperFactoryBean"
+ * <pre class="code">{@code
+ * <bean class="org.springframework.http.converter.json.MappingJackson2HttpMessageConverter">
+ *   <property name="objectMapper">
+ *     <bean class="org.springframework.http.converter.json.Jackson2ObjectMapperFactoryBean"
 *       p:autoDetectFields="false"
 *       p:autoDetectGettersSetters="false"
 *       p:annotationIntrospector-ref="jaxbAnnotationIntrospector" />
- *   &lt;/property>
- * &lt;/bean>
- * </pre>
+ *   </property>
+ * </bean>
+ * }</pre>
 *
 * <p>Example usage with MappingJackson2JsonView:
 *
- * <pre class="code">
- * &lt;bean class="org.springframework.web.servlet.view.json.MappingJackson2JsonView">
- *   &lt;property name="objectMapper">
- *     &lt;bean class="org.springframework.http.converter.json.Jackson2ObjectMapperFactoryBean"
+ * <pre class="code">{@code
+ * <bean class="org.springframework.web.servlet.view.json.MappingJackson2JsonView">
+ *   <property name="objectMapper">
+ *     <bean class="org.springframework.http.converter.json.Jackson2ObjectMapperFactoryBean"
 *       p:failOnEmptyBeans="false"
 *       p:indentOutput="true">
- *       &lt;property name="serializers">
- *         &lt;array>
- *           &lt;bean class="org.mycompany.MyCustomSerializer" />
- *         &lt;/array>
- *       &lt;/property>
- *     &lt;/bean>
- *   &lt;/property>
- * &lt;/bean>
- * </pre>
+ *       <property name="serializers">
+ *         <array>
+ *           <bean class="org.mycompany.MyCustomSerializer" />
+ *         </array>
+ *       </property>
+ *     </bean>
+ *   </property>
+ * </bean>
+ * }</pre>
 *
 * <p>In case there are no specific setters provided (for some rarely used options),
 * you can still use the more general methods  {@link #setFeaturesToEnable} and
 * {@link #setFeaturesToDisable}.
 *
- * <pre class="code">
- * &lt;bean class="org.springframework.http.converter.json.Jackson2ObjectMapperFactoryBean">
- *   &lt;property name="featuresToEnable">
- *     &lt;array>
- *       &lt;util:constant static-field="com.fasterxml.jackson.databind.SerializationFeature.WRAP_ROOT_VALUE"/>
- *       &lt;util:constant static-field="com.fasterxml.jackson.databind.SerializationFeature.CLOSE_CLOSEABLE"/>
- *     &lt;/array>
- *   &lt;/property>
- *   &lt;property name="featuresToDisable">
- *     &lt;array>
- *       &lt;util:constant static-field="com.fasterxml.jackson.databind.MapperFeature.USE_ANNOTATIONS"/>
- *     &lt;/array>
- *   &lt;/property>
- * &lt;/bean>
- * </pre>
+ * <pre class="code">{@code
+ * <bean class="org.springframework.http.converter.json.Jackson2ObjectMapperFactoryBean">
+ *   <property name="featuresToEnable">
+ *     <array>
+ *       <util:constant static-field="com.fasterxml.jackson.databind.SerializationFeature.WRAP_ROOT_VALUE"/>
+ *       <util:constant static-field="com.fasterxml.jackson.databind.SerializationFeature.CLOSE_CLOSEABLE"/>
+ *     </array>
+ *   </property>
+ *   <property name="featuresToDisable">
+ *     <array>
+ *       <util:constant static-field="com.fasterxml.jackson.databind.MapperFeature.USE_ANNOTATIONS"/>
+ *     </array>
+ *   </property>
+ * </bean>
+ * }</pre>
 *
 * <p>It also automatically registers the following well-known modules if they are
 * detected on the classpath:
@@ -119,7 +119,7 @@ import org.springframework.lang.Nullable;
 * <li><a href="https://github.com/FasterXML/jackson-datatype-jdk8">jackson-datatype-jdk8</a>:
 * support for other Java 8 types like {@link java.util.Optional}</li>
 * <li><a href="https://github.com/FasterXML/jackson-datatype-jsr310">jackson-datatype-jsr310</a>:
- * support for Java 8 Date & Time API types</li>
+ * support for Java 8 Date &amp; Time API types</li>
 * <li><a href="https://github.com/FasterXML/jackson-datatype-joda">jackson-datatype-joda</a>:
 * support for Joda-Time types</li>
 * <li><a href="https://github.com/FasterXML/jackson-module-kotlin">jackson-module-kotlin</a>:
@@ -129,11 +129,11 @@ import org.springframework.lang.Nullable;
 * <p>In case you want to configure Jackson's {@link ObjectMapper} with a custom {@link Module},
 * you can register one or more such Modules by class name via {@link #setModulesToInstall}:
 *
- * <pre class="code">
- * &lt;bean class="org.springframework.http.converter.json.Jackson2ObjectMapperFactoryBean">
- *   &lt;property name="modulesToInstall" value="myapp.jackson.MySampleModule,myapp.jackson.MyOtherModule"/>
- * &lt;/bean
- * </pre>
+ * <pre class="code">{@code
+ * <bean class="org.springframework.http.converter.json.Jackson2ObjectMapperFactoryBean">
+ *   <property name="modulesToInstall" value="myapp.jackson.MySampleModule,myapp.jackson.MyOtherModule"/>
+ * </bean
+ * }</pre>
 *
 * <p>Compatible with Jackson 2.9 to 2.12, as of Spring 5.3.
 *
--- a/spring-web/src/main/java/org/springframework/web/util/HtmlUtils.java
+++ b/spring-web/src/main/java/org/springframework/web/util/HtmlUtils.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2019 the original author or authors.
+ * Copyright 2002-2021 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.
@@ -49,7 +49,7 @@ public abstract class HtmlUtils {

 	/**
 	 * Turn special characters into HTML character references.
-	 * <p>Handles complete character set defined in HTML 4.01 recommendation.
+	 * <p>Handles the complete character set defined in the HTML 4.01 recommendation.
 	 * <p>Escapes all special characters to their corresponding
 	 * entity reference (e.g. {@code &lt;}).
 	 * <p>Reference:
@@ -65,7 +65,7 @@ public abstract class HtmlUtils {

 	/**
 	 * Turn special characters into HTML character references.
-	 * <p>Handles complete character set defined in HTML 4.01 recommendation.
+	 * <p>Handles the complete character set defined in the HTML 4.01 recommendation.
 	 * <p>Escapes all special characters to their corresponding
 	 * entity reference (e.g. {@code &lt;}) at least as required by the
 	 * specified encoding. In other words, if a special character does
@@ -98,9 +98,9 @@ public abstract class HtmlUtils {

 	/**
 	 * Turn special characters into HTML character references.
-	 * <p>Handles complete character set defined in HTML 4.01 recommendation.
+	 * <p>Handles the complete character set defined in the HTML 4.01 recommendation.
 	 * <p>Escapes all special characters to their corresponding numeric
-	 * reference in decimal format (&#<i>Decimal</i>;).
+	 * reference in decimal format (&amp;#<i>Decimal</i>;).
 	 * <p>Reference:
 	 * <a href="https://www.w3.org/TR/html4/sgml/entities.html">
 	 * https://www.w3.org/TR/html4/sgml/entities.html
@@ -114,9 +114,9 @@ public abstract class HtmlUtils {

 	/**
 	 * Turn special characters into HTML character references.
-	 * <p>Handles complete character set defined in HTML 4.01 recommendation.
+	 * <p>Handles the complete character set defined in the HTML 4.01 recommendation.
 	 * <p>Escapes all special characters to their corresponding numeric
-	 * reference in decimal format (&#<i>Decimal</i>;) at least as required by the
+	 * reference in decimal format (&amp;#<i>Decimal</i>;) at least as required by the
 	 * specified encoding. In other words, if a special character does
 	 * not have to be escaped for the given encoding, it may not be.
 	 * <p>Reference:
@@ -148,9 +148,9 @@ public abstract class HtmlUtils {

 	/**
 	 * Turn special characters into HTML character references.
-	 * <p>Handles complete character set defined in HTML 4.01 recommendation.
+	 * <p>Handles the complete character set defined in the HTML 4.01 recommendation.
 	 * <p>Escapes all special characters to their corresponding numeric
-	 * reference in hex format (&#x<i>Hex</i>;).
+	 * reference in hex format (&amp;#x<i>Hex</i>;).
 	 * <p>Reference:
 	 * <a href="https://www.w3.org/TR/html4/sgml/entities.html">
 	 * https://www.w3.org/TR/html4/sgml/entities.html
@@ -164,9 +164,9 @@ public abstract class HtmlUtils {

 	/**
 	 * Turn special characters into HTML character references.
-	 * <p>Handles complete character set defined in HTML 4.01 recommendation.
+	 * <p>Handles the complete character set defined in the HTML 4.01 recommendation.
 	 * <p>Escapes all special characters to their corresponding numeric
-	 * reference in hex format (&#x<i>Hex</i>;) at least as required by the
+	 * reference in hex format (&amp;#x<i>Hex</i>;) at least as required by the
 	 * specified encoding. In other words, if a special character does
 	 * not have to be escaped for the given encoding, it may not be.
 	 * <p>Reference:
--- a/spring-web/src/main/java/org/springframework/web/util/UriTemplate.java
+++ b/spring-web/src/main/java/org/springframework/web/util/UriTemplate.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2020 the original author or authors.
+ * Copyright 2002-2021 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.
@@ -92,7 +92,7 @@ public class UriTemplate implements Serializable {
 	 * UriTemplate template = new UriTemplate("https://example.com/hotels/{hotel}/bookings/{booking}");
 	 * Map&lt;String, String&gt; uriVariables = new HashMap&lt;String, String&gt;();
 	 * uriVariables.put("booking", "42");
-	 * uriVariables.put("hotel", "Rest & Relax");
+	 * uriVariables.put("hotel", "Rest &amp; Relax");
 	 * System.out.println(template.expand(uriVariables));
 	 * </pre>
 	 * will print: <blockquote>{@code https://example.com/hotels/Rest%20%26%20Relax/bookings/42}</blockquote>
@@ -113,7 +113,7 @@ public class UriTemplate implements Serializable {
 	 * <p>Example:
 	 * <pre class="code">
 	 * UriTemplate template = new UriTemplate("https://example.com/hotels/{hotel}/bookings/{booking}");
-	 * System.out.println(template.expand("Rest & Relax", 42));
+	 * System.out.println(template.expand("Rest &amp; Relax", 42));
 	 * </pre>
 	 * will print: <blockquote>{@code https://example.com/hotels/Rest%20%26%20Relax/bookings/42}</blockquote>
 	 * @param uriVariableValues the array of URI variables
--- a/spring-web/src/main/java/org/springframework/web/util/UriUtils.java
+++ b/spring-web/src/main/java/org/springframework/web/util/UriUtils.java
@@ -246,15 +246,15 @@ public abstract class UriUtils {
 	 * Encode the query parameters from the given {@code MultiValueMap} with UTF-8.
 	 * <p>This can be used with {@link UriComponentsBuilder#queryParams(MultiValueMap)}
 	 * when building a URI from an already encoded template.
-	 * <pre class="code">
-	 * MultiValueMap&lt;String, String&gt; params = new LinkedMultiValueMap<>(2);
+	 * <pre class="code">{@code
+	 * MultiValueMap<String, String> params = new LinkedMultiValueMap<>(2);
 	 * // add to params...
 	 *
 	 * ServletUriComponentsBuilder.fromCurrentRequest()
 	 *         .queryParams(UriUtils.encodeQueryParams(params))
 	 *         .build(true)
 	 *         .toUriString();
-	 * </pre>
+	 * }</pre>
 	 * @param params the parameters to encode
 	 * @return a new {@code MultiValueMap} with the encoded names and values
 	 * @since 5.2.3