Fix recent javadoc errors

Issue: SPR-17174
This commit is contained in:
Juergen Hoeller
2018-08-16 18:51:31 +02:00
parent 1eb06fcd90
commit 84300b796c
16 changed files with 53 additions and 54 deletions

View File

@@ -320,20 +320,20 @@ public interface ServerRequest {
interface Headers {
/**
* Return the list of acceptable {@linkplain MediaType media types},
* Return the list of acceptable {@code MediaType media types},
* as specified by the {@code Accept} header.
* <p>Returns an empty list when the acceptable media types are unspecified.
*/
List<MediaType> accept();
/**
* Return the list of acceptable {@linkplain Charset charsets},
* Return the list of acceptable {@code Charset charsets},
* as specified by the {@code Accept-Charset} header.
*/
List<Charset> acceptCharset();
/**
* Return the list of acceptable {@linkplain Locale.LanguageRange languages},
* Return the list of acceptable {@code Locale.LanguageRange languages},
* as specified by the {@code Accept-Language} header.
*/
List<Locale.LanguageRange> acceptLanguage();
@@ -345,7 +345,7 @@ public interface ServerRequest {
OptionalLong contentLength();
/**
* Return the {@linkplain MediaType media type} of the body, as specified
* Return the {@code MediaType media type} of the body, as specified
* by the {@code Content-Type} header.
*/
Optional<MediaType> contentType();
@@ -398,7 +398,7 @@ public interface ServerRequest {
*/
Builder uri(URI uri);
/**
/**
* Add the given header value(s) under the given name.
* @param headerName the header name
* @param headerValues the header value(s)
@@ -427,8 +427,8 @@ public interface ServerRequest {
Builder cookie(String name, String... values);
/**
* Manipulate this request's cookies with the given consumer. The
* map provided to the consumer is "live", so that the consumer can be used to
* Manipulate this request's cookies with the given consumer.
* The map provided to the consumer is "live", so that the consumer can be used to
* {@linkplain MultiValueMap#set(Object, Object) overwrite} existing header values,
* {@linkplain MultiValueMap#remove(Object) remove} values, or use any of the other
* {@link MultiValueMap} methods.
@@ -465,9 +465,9 @@ public interface ServerRequest {
Builder attribute(String name, Object value);
/**
* Manipulate this request's attributes with the given consumer. The map provided to the
* consumer is "live", so that the consumer can be used to
* {@linkplain Map#put(Object, Object) overwrite} existing header values,
* Manipulate this request's attributes with the given consumer.
* The map provided to the consumer is "live", so that the consumer can be used
* to {@linkplain Map#put(Object, Object) overwrite} existing header values,
* {@linkplain Map#remove(Object) remove} values, or use any of the other
* {@link Map} methods.
* @param attributesConsumer a function that consumes the attributes map

View File

@@ -116,9 +116,10 @@ public class UndertowWebSocketClient implements WebSocketClient {
/**
* Set the {@link io.undertow.connector.ByteBufferPool ByteBufferPool} to pass to
* {@link io.undertow.websockets.client.WebSocketClient#connectionBuilder}.
* <p>By default an indirect {@link io.undertow.server.DefaultByteBufferPool} with a buffer size
* of {@value #DEFAULT_POOL_BUFFER_SIZE} is used.
* <p>By default an indirect {@link io.undertow.server.DefaultByteBufferPool}
* with a buffer size of 8192 is used.
* @since 5.0.8
* @see #DEFAULT_POOL_BUFFER_SIZE
*/
public void setByteBufferPool(ByteBufferPool byteBufferPool) {
Assert.notNull(byteBufferPool, "ByteBufferPool must not be null");