Fix recent javadoc errors

Issue: SPR-17174

Author: jhoeller

spring-context/src/main/java/org/springframework/context/support/ResourceBundleMessageSource.java

@@ -347,9 +347,9 @@ public String toString() {
 
 
 	/**
-	 * Custom implementation of Java 6's {@code ResourceBundle.Control},
-	 * adding support for custom file encodings, deactivating the fallback to the
-	 * system locale and activating ResourceBundle's native cache, if desired.
+	 * Custom implementation of {@code ResourceBundle.Control}, adding support
+	 * for custom file encodings, deactivating the fallback to the system locale
+	 * and activating ResourceBundle's native cache, if desired.
 	 */
 	private class MessageSourceControl extends ResourceBundle.Control {
 

spring-messaging/src/main/java/org/springframework/messaging/tcp/reactor/ReactorNettyTcpClient.java

@@ -102,27 +102,24 @@ public ReactorNettyTcpClient(String host, int port, ReactorNettyCodec<P> codec)
 	}
 
 	/**
-	 * Constructor with a {@link ClientOptions.Builder} that can be used to
+	 * Constructor with a {@code ClientOptions.Builder} that can be used to
 	 * customize Reactor Netty client options.
-	 *
 	 * <p><strong>Note: </strong> this constructor manages the lifecycle of the
 	 * {@link TcpClient} and its underlying resources. Please do not customize
 	 * any of the following options:
-	 * {@link ClientOptions.Builder#channelGroup(ChannelGroup) ChannelGroup},
-	 * {@link ClientOptions.Builder#loopResources(LoopResources) LoopResources}, and
-	 * {@link ClientOptions.Builder#poolResources(PoolResources) PoolResources}.
-	 * You may set the {@link ClientOptions.Builder#disablePool() disablePool}
+	 * {@code ClientOptions.Builder#channelGroup(ChannelGroup) ChannelGroup},
+	 * {@code ClientOptions.Builder#loopResources(LoopResources) LoopResources}, and
+	 * {@code ClientOptions.Builder#poolResources(PoolResources) PoolResources}.
+	 * You may set the {@code ClientOptions.Builder#disablePool() disablePool}
 	 * option if you simply want to turn off pooling.
-	 *
 	 * <p>For full control over the initialization and lifecycle of the TcpClient,
 	 * see {@link #ReactorNettyTcpClient(TcpClient, ReactorNettyCodec)}.
-	 *
 	 * @param optionsConsumer consumer to customize client options
 	 * @param codec the code to use
 	 * @see org.springframework.messaging.simp.stomp.StompReactorNettyCodec
 	 */
-	public ReactorNettyTcpClient(Consumer<ClientOptions.Builder<?>> optionsConsumer,
-			ReactorNettyCodec<P> codec) {
+	public ReactorNettyTcpClient(
+			Consumer<ClientOptions.Builder<?>> optionsConsumer, ReactorNettyCodec<P> codec) {
 
 		Assert.notNull(optionsConsumer, "Consumer<ClientOptions.Builder<?> is required");
 		Assert.notNull(codec, "ReactorNettyCodec is required");
@@ -155,7 +152,6 @@ public ReactorNettyTcpClient(Consumer<ClientOptions.Builder<?>> optionsConsumer,
 	/**
 	 * Constructor with an externally created {@link TcpClient} instance whose
 	 * lifecycle is expected to be managed externally.
-	 *
 	 * @param tcpClient the TcpClient instance to use
 	 * @param codec the code to use
 	 * @see org.springframework.messaging.simp.stomp.StompReactorNettyCodec

spring-test/src/main/java/org/springframework/test/web/reactive/server/WebTestClient.java

@@ -359,8 +359,10 @@ interface RouterFunctionSpec extends MockServerSpec<RouterFunctionSpec> {
 
 
 	/**
-	 * Steps for customizing the {@link WebClient} used to test with
-	 * internally delegating to a {@link WebClient.Builder}.
+	 * Steps for customizing the {@link WebClient} used to test with,
+	 * internally delegating to a
+	 * {@link org.springframework.web.reactive.function.client.WebClient.Builder
+	 * WebClient.Builder}.
 	 */
 	interface Builder {
 
@@ -443,7 +445,8 @@ interface Builder {
 		Builder responseTimeout(Duration timeout);
 
 		/**
-		 * Shortcut for pre-packaged customizations to WebTestClient builder.
+		 * Apply the given configurer to this builder instance.
+		 * <p>This can be useful for applying pre-packaged customizations.
 		 * @param configurer the configurer to apply
 		 */
 		Builder apply(WebTestClientConfigurer configurer);
@@ -591,6 +594,9 @@ interface RequestHeadersSpec<S extends RequestHeadersSpec<S>> {
 	}
 
 
+	/**
+	 * Specification for providing body of a request.
+	 */
 	interface RequestBodySpec extends RequestHeadersSpec<RequestBodySpec> {
 		/**
 		 * Set the length of the body in bytes, as specified by the
@@ -649,10 +655,15 @@ interface RequestBodySpec extends RequestHeadersSpec<RequestBodySpec> {
 	}
 
 
+	/**
+	 * Specification for providing request headers and the URI of a request.
+	 */
 	interface RequestHeadersUriSpec<S extends RequestHeadersSpec<S>> extends UriSpec<S>, RequestHeadersSpec<S> {
 	}
 
-
+	/**
+	 * Specification for providing the body and the URI of a request.
+	 */
 	interface RequestBodyUriSpec extends RequestBodySpec, RequestHeadersUriSpec<RequestBodySpec> {
 	}
 
@@ -792,7 +803,7 @@ interface BodyContentSpec {
 		 * Parse the expected and actual response content as JSON and perform a
 		 * "lenient" comparison verifying the same attribute-value pairs.
 		 * <p>Use of this option requires the
-		 * <a href="http://jsonassert.skyscreamer.org/">JSONassert<a/> library
+		 * <a href="http://jsonassert.skyscreamer.org/">JSONassert</a> library
 		 * on to be on the classpath.
 		 * @param expectedJson the expected JSON content.
 		 */

spring-web/src/main/java/org/springframework/http/client/OkHttp3ClientHttpRequestFactory.java

@@ -71,9 +71,8 @@ public OkHttp3ClientHttpRequestFactory(OkHttpClient client) {
 
 
 	/**
-	 * Sets the underlying read timeout in milliseconds.
+	 * Set the underlying read timeout in milliseconds.
 	 * A value of 0 specifies an infinite timeout.
-	 * @see OkHttpClient.Builder#readTimeout(long, TimeUnit)
 	 */
 	public void setReadTimeout(int readTimeout) {
 		this.client = this.client.newBuilder()
@@ -82,9 +81,8 @@ public void setReadTimeout(int readTimeout) {
 	}
 
 	/**
-	 * Sets the underlying write timeout in milliseconds.
+	 * Set the underlying write timeout in milliseconds.
 	 * A value of 0 specifies an infinite timeout.
-	 * @see OkHttpClient.Builder#writeTimeout(long, TimeUnit)
 	 */
 	public void setWriteTimeout(int writeTimeout) {
 		this.client = this.client.newBuilder()
@@ -93,9 +91,8 @@ public void setWriteTimeout(int writeTimeout) {
 	}
 
 	/**
-	 * Sets the underlying connect timeout in milliseconds.
+	 * Set the underlying connect timeout in milliseconds.
 	 * A value of 0 specifies an infinite timeout.
-	 * @see OkHttpClient.Builder#connectTimeout(long, TimeUnit)
 	 */
 	public void setConnectTimeout(int connectTimeout) {
 		this.client = this.client.newBuilder()

spring-web/src/main/java/org/springframework/http/client/reactive/ReactorClientHttpConnector.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2017 the original author or authors.
+ * Copyright 2002-2018 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.
@@ -53,7 +53,7 @@ public ReactorClientHttpConnector() {
 
 	/**
 	 * Create a Reactor Netty {@link ClientHttpConnector} with the given
-	 * {@link HttpClientOptions.Builder}
+	 * {@code HttpClientOptions.Builder}
 	 */
 	public ReactorClientHttpConnector(Consumer<? super HttpClientOptions.Builder> clientOptions) {
 		this.httpClient = HttpClient.create(clientOptions);

spring-web/src/main/java/org/springframework/http/converter/protobuf/ProtobufJsonFormatHttpMessageConverter.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2017 the original author or authors.
+ * Copyright 2002-2018 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.
@@ -41,15 +41,15 @@ public class ProtobufJsonFormatHttpMessageConverter extends ProtobufHttpMessageC
 
 	/**
 	 * Construct a new {@code ProtobufJsonFormatHttpMessageConverter} with default
-	 * {@link JsonFormat.Parser} and {@link JsonFormat.Printer} configuration.
+	 * {@code JsonFormat.Parser} and {@code JsonFormat.Printer} configuration.
 	 */
 	public ProtobufJsonFormatHttpMessageConverter() {
 		this(null,  null, null);
 	}
 
 	/**
 	 * Construct a new {@code ProtobufJsonFormatHttpMessageConverter} with the given
-	 * {@link JsonFormat.Parser} and {@link JsonFormat.Printer} configuration.
+	 * {@code JsonFormat.Parser} and {@code JsonFormat.Printer} configuration.
 	 * @param parser the JSON parser configuration
 	 * @param printer the JSON printer configuration
 	 */
@@ -61,8 +61,8 @@ public ProtobufJsonFormatHttpMessageConverter(
 
 	/**
 	 * Construct a new {@code ProtobufJsonFormatHttpMessageConverter} with the given
-	 * {@link JsonFormat.Parser} and {@link JsonFormat.Printer} configuration, also
-	 * accepting an initializer that allows the registration of message extensions
+	 * {@code JsonFormat.Parser} and {@code JsonFormat.Printer} configuration, also
+	 * accepting an initializer that allows the registration of message extensions.
 	 * @param parser the JSON parser configuration
 	 * @param printer the JSON printer configuration
 	 * @param registryInitializer an initializer for message extensions

spring-web/src/main/java/org/springframework/http/server/reactive/HttpHandler.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2016 the original author or authors.
+ * Copyright 2002-2018 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.
@@ -24,16 +24,16 @@
  *
  * <p>Higher-level, but still generic, building blocks for applications such as
  * {@code WebFilter}, {@code WebSession}, {@code ServerWebExchange}, and others
- * are available in the {@link org.springframework.web.server} package.
+ * are available in the {@code org.springframework.web.server} package.
  *
  * <p>Application level programming models such as annotated controllers and
  * functional handlers are available in the {@code spring-webflux} module.
  *
  * <p>Typically an {@link HttpHandler} represents an entire application with
  * higher-level programming models bridged via
- * {@link org.springframework.web.server.adapter.WebHttpHandlerBuilder
- * WebHttpHandlerBuilder}. Multiple applications at unique context paths can be
- * plugged in with the help of the {@link ContextPathCompositeHandler}.
+ * {@link org.springframework.web.server.adapter.WebHttpHandlerBuilder}.
+ * Multiple applications at unique context paths can be plugged in with the
+ * help of the {@link ContextPathCompositeHandler}.
  *
  * @author Arjen Poutsma
  * @author Rossen Stoyanchev

spring-web/src/main/java/org/springframework/web/client/DefaultResponseErrorHandler.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2017 the original author or authors.
+ * Copyright 2002-2018 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.
@@ -55,8 +55,8 @@ public boolean hasError(ClientHttpResponse response) throws IOException {
 	/**
 	 * Template method called from {@link #hasError(ClientHttpResponse)}.
 	 * <p>The default implementation checks if the given status code is
-	 * {@link HttpStatus.Series#CLIENT_ERROR CLIENT_ERROR} or
-	 * {@link HttpStatus.Series#SERVER_ERROR SERVER_ERROR}.
+	 * {@code HttpStatus.Series#CLIENT_ERROR CLIENT_ERROR} or
+	 * {@code HttpStatus.Series#SERVER_ERROR SERVER_ERROR}.
 	 * Can be overridden in subclasses.
 	 * @param statusCode the HTTP status code
 	 * @return {@code true} if the response has an error; {@code false} otherwise
@@ -101,7 +101,6 @@ protected void handleError(ClientHttpResponse response, HttpStatus statusCode) t
 		}
 	}
 
-
 	/**
 	 * Determine the HTTP status of the given response.
 	 * @param response the response to inspect

spring-web/src/main/java/org/springframework/web/client/ExtractingResponseErrorHandler.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2017 the original author or authors.
+ * Copyright 2002-2018 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.
@@ -29,25 +29,25 @@
 import org.springframework.util.CollectionUtils;
 
 /**
- * Implementation of {@link ResponseErrorHandler} that uses {@link HttpMessageConverter}s to
- * convert HTTP error responses to {@link RestClientException}.
+ * Implementation of {@link ResponseErrorHandler} that uses {@link HttpMessageConverter}s
+ * to convert HTTP error responses to {@link RestClientException}.
  *
  * <p>To use this error handler, you must specify a
  * {@linkplain #setStatusMapping(Map) status mapping} and/or a
  * {@linkplain #setSeriesMapping(Map) series mapping}. If either of these mappings has a match
  * for the {@linkplain ClientHttpResponse#getStatusCode() status code} of a given
  * {@code ClientHttpResponse}, {@link #hasError(ClientHttpResponse)} will return
- * {@code true} and {@link #handleError(ClientHttpResponse)} will attempt to use the
+ * {@code true}, and {@link #handleError(ClientHttpResponse)} will attempt to use the
  * {@linkplain #setMessageConverters(List) configured message converters} to convert the response
  * into the mapped subclass of {@link RestClientException}. Note that the
  * {@linkplain #setStatusMapping(Map) status mapping} takes precedence over
  * {@linkplain #setSeriesMapping(Map) series mapping}.
  *
  * <p>If there is no match, this error handler will default to the behavior of
- * {@link DefaultResponseErrorHandler}. Note that you can override this default behavior by
- * specifying a {@linkplain #setSeriesMapping(Map) series mapping} from
- * {@link HttpStatus.Series#CLIENT_ERROR} and/or {@link HttpStatus.Series#SERVER_ERROR} to
- * {@code null}.
+ * {@link DefaultResponseErrorHandler}. Note that you can override this default behavior
+ * by specifying a {@linkplain #setSeriesMapping(Map) series mapping} from
+ * {@code HttpStatus.Series#CLIENT_ERROR} and/or {@code HttpStatus.Series#SERVER_ERROR}
+ * to {@code null}.
  *
  * @author Simon Galperin
  * @author Arjen Poutsma

spring-web/src/main/java/org/springframework/web/client/RestOperations.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2017 the original author or authors.
+ * Copyright 2002-2018 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.
@@ -657,7 +657,7 @@ <T> ResponseEntity<T> exchange(RequestEntity<?> requestEntity, ParameterizedType
 			throws RestClientException;
 
 
-	// general execution
+	// General execution
 
 	/**
 	 * Execute the HTTP method to the given URI template, preparing the request with the