Fix links, @⁠since tags, formatting, etc. in RestTestClient

Author: sbrannen

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

@@ -601,23 +601,23 @@ interface RequestHeadersSpec<S extends RequestHeadersSpec<S>> {
 		 * Set the list of acceptable {@linkplain MediaType media types}, as
 		 * specified by the {@code Accept} header.
 		 * @param acceptableMediaTypes the acceptable media types
-		 * @return the same instance
+		 * @return this spec for further declaration of the request
 		 */
 		S accept(MediaType... acceptableMediaTypes);
 
 		/**
 		 * Set the list of acceptable {@linkplain Charset charsets}, as specified
 		 * by the {@code Accept-Charset} header.
 		 * @param acceptableCharsets the acceptable charsets
-		 * @return the same instance
+		 * @return this spec for further declaration of the request
 		 */
 		S acceptCharset(Charset... acceptableCharsets);
 
 		/**
 		 * Add a cookie with the given name and value.
 		 * @param name the cookie name
 		 * @param value the cookie value
-		 * @return the same instance
+		 * @return this spec for further declaration of the request
 		 */
 		S cookie(String name, String value);
 
@@ -628,7 +628,7 @@ interface RequestHeadersSpec<S extends RequestHeadersSpec<S>> {
 		 * {@linkplain MultiValueMap#remove(Object) remove} values, or use any of the other
 		 * {@link MultiValueMap} methods.
 		 * @param cookiesConsumer a function that consumes the cookies map
-		 * @return this builder
+		 * @return this spec for further declaration of the request
 		 */
 		S cookies(Consumer<MultiValueMap<String, String>> cookiesConsumer);
 
@@ -637,22 +637,22 @@ interface RequestHeadersSpec<S extends RequestHeadersSpec<S>> {
 		 * <p>The date should be specified as the number of milliseconds since
 		 * January 1, 1970 GMT.
 		 * @param ifModifiedSince the new value of the header
-		 * @return the same instance
+		 * @return this spec for further declaration of the request
 		 */
 		S ifModifiedSince(ZonedDateTime ifModifiedSince);
 
 		/**
 		 * Set the values of the {@code If-None-Match} header.
 		 * @param ifNoneMatches the new value of the header
-		 * @return the same instance
+		 * @return this spec for further declaration of the request
 		 */
 		S ifNoneMatch(String... ifNoneMatches);
 
 		/**
 		 * Add the given, single header value under the given name.
 		 * @param headerName  the header name
 		 * @param headerValues the header value(s)
-		 * @return the same instance
+		 * @return this spec for further declaration of the request
 		 */
 		S header(String headerName, String... headerValues);
 
@@ -663,7 +663,7 @@ interface RequestHeadersSpec<S extends RequestHeadersSpec<S>> {
 		 * {@linkplain HttpHeaders#remove(String) remove} values, or use any of the other
 		 * {@link HttpHeaders} methods.
 		 * @param headersConsumer a function that consumes the {@code HttpHeaders}
-		 * @return this builder
+		 * @return this spec for further declaration of the request
 		 */
 		S headers(Consumer<HttpHeaders> headersConsumer);
 
@@ -674,6 +674,7 @@ interface RequestHeadersSpec<S extends RequestHeadersSpec<S>> {
 		 * @param version the API version of the request; this can be a String or
 		 * some Object that can be formatted by the inserter &mdash; for example,
 		 * through an {@link ApiVersionFormatter}
+		 * @return this spec for further declaration of the request
 		 * @since 7.0
 		 */
 		S apiVersion(Object version);
@@ -682,7 +683,7 @@ interface RequestHeadersSpec<S extends RequestHeadersSpec<S>> {
 		 * Set the attribute with the given name to the given value.
 		 * @param name the name of the attribute to add
 		 * @param value the value of the attribute to add
-		 * @return this builder
+		 * @return this spec for further declaration of the request
 		 */
 		S attribute(String name, Object value);
 
@@ -691,28 +692,28 @@ interface RequestHeadersSpec<S extends RequestHeadersSpec<S>> {
 		 * the consumer are "live", so that the consumer can be used to inspect attributes,
 		 * remove attributes, or use any of the other map-provided methods.
 		 * @param attributesConsumer a function that consumes the attributes
-		 * @return this builder
+		 * @return this spec for further declaration of the request
 		 */
 		S attributes(Consumer<Map<String, Object>> attributesConsumer);
 
 		/**
 		 * Perform the exchange without a request body.
-		 * @return spec for decoding the response
+		 * @return a spec for decoding the response
 		 */
 		ResponseSpec exchange();
 	}
 
 
 	/**
-	 * Specification for providing body of a request.
+	 * Specification for providing the body of a request.
 	 */
 	interface RequestBodySpec extends RequestHeadersSpec<RequestBodySpec> {
 
 		/**
 		 * Set the length of the body in bytes, as specified by the
 		 * {@code Content-Length} header.
 		 * @param contentLength the content length
-		 * @return the same instance
+		 * @return this spec for further declaration of the request
 		 * @see HttpHeaders#setContentLength(long)
 		 */
 		RequestBodySpec contentLength(long contentLength);
@@ -721,7 +722,7 @@ interface RequestBodySpec extends RequestHeadersSpec<RequestBodySpec> {
 		 * Set the {@linkplain MediaType media type} of the body, as specified
 		 * by the {@code Content-Type} header.
 		 * @param contentType the content type
-		 * @return the same instance
+		 * @return this spec for further declaration of the request
 		 * @see HttpHeaders#setContentType(MediaType)
 		 */
 		RequestBodySpec contentType(MediaType contentType);
@@ -731,7 +732,7 @@ interface RequestBodySpec extends RequestHeadersSpec<RequestBodySpec> {
 		 * {@link WebClient.RequestBodySpec#bodyValue(Object)
 		 * bodyValue} method on the underlying {@code WebClient}.
 		 * @param body the value to write to the request body
-		 * @return spec for further declaration of the request
+		 * @return this spec for further declaration of the request
 		 * @since 5.2
 		 */
 		RequestHeadersSpec<?> bodyValue(Object body);
@@ -744,7 +745,7 @@ interface RequestBodySpec extends RequestHeadersSpec<RequestBodySpec> {
 		 * @param elementClass the class of elements contained in the publisher
 		 * @param <T> the type of the elements contained in the publisher
 		 * @param <S> the type of the {@code Publisher}
-		 * @return spec for further declaration of the request
+		 * @return this spec for further declaration of the request
 		 */
 		<T, S extends Publisher<T>> RequestHeadersSpec<?> body(S publisher, Class<T> elementClass);
 
@@ -755,7 +756,7 @@ interface RequestBodySpec extends RequestHeadersSpec<RequestBodySpec> {
 		 * @param elementTypeRef the type reference of elements contained in the publisher
 		 * @param <T> the type of the elements contained in the publisher
 		 * @param <S> the type of the {@code Publisher}
-		 * @return spec for further declaration of the request
+		 * @return this spec for further declaration of the request
 		 * @since 5.2
 		 */
 		<T, S extends Publisher<T>> RequestHeadersSpec<?> body(
@@ -769,7 +770,7 @@ <T, S extends Publisher<T>> RequestHeadersSpec<?> body(
 		 * {@link Publisher} or another producer adaptable to a
 		 * {@code Publisher} via {@link ReactiveAdapterRegistry}
 		 * @param elementClass the class of elements contained in the producer
-		 * @return spec for further declaration of the request
+		 * @return this spec for further declaration of the request
 		 * @since 5.2
 		 */
 		RequestHeadersSpec<?> body(Object producer, Class<?> elementClass);
@@ -782,18 +783,18 @@ <T, S extends Publisher<T>> RequestHeadersSpec<?> body(
 		 * {@link Publisher} or another producer adaptable to a
 		 * {@code Publisher} via {@link ReactiveAdapterRegistry}
 		 * @param elementTypeRef the type reference of elements contained in the producer
-		 * @return spec for further declaration of the request
+		 * @return this spec for further declaration of the request
 		 * @since 5.2
 		 */
 		RequestHeadersSpec<?> body(Object producer, ParameterizedTypeReference<?> elementTypeRef);
 
 		/**
 		 * Set the body of the request to the given {@code BodyInserter}.
-		 * This method invokes the
+		 * <p>This method invokes the
 		 * {@link WebClient.RequestBodySpec#body(BodyInserter)
 		 * body(BodyInserter)} method on the underlying {@code WebClient}.
 		 * @param inserter the body inserter to use
-		 * @return spec for further declaration of the request
+		 * @return this spec for further declaration of the request
 		 * @see org.springframework.web.reactive.function.BodyInserters
 		 */
 		RequestHeadersSpec<?> body(BodyInserter<?, ? super ClientHttpRequest> inserter);