Fix checkstyle javadoc issues

Fix checkstyle issues in javadoc following the spring-javaformat
upgrade.

See gh-13932
This commit is contained in:
Phillip Webb
2018-07-26 17:58:28 +01:00
parent 7fc455654a
commit e6a68b39a3
51 changed files with 110 additions and 110 deletions

View File

@@ -55,9 +55,9 @@ public class AuditEvent implements Serializable {
/**
* Create a new audit event for the current time.
* @param principal The user principal responsible
* @param principal the user principal responsible
* @param type the event type
* @param data The event data
* @param data the event data
*/
public AuditEvent(String principal, String type, Map<String, Object> data) {
this(Instant.now(), principal, type, data);
@@ -66,9 +66,9 @@ public class AuditEvent implements Serializable {
/**
* Create a new audit event for the current time from data provided as name-value
* pairs.
* @param principal The user principal responsible
* @param principal the user principal responsible
* @param type the event type
* @param data The event data in the form 'key=value' or simply 'key'
* @param data the event data in the form 'key=value' or simply 'key'
*/
public AuditEvent(String principal, String type, String... data) {
this(Instant.now(), principal, type, convert(data));
@@ -76,10 +76,10 @@ public class AuditEvent implements Serializable {
/**
* Create a new audit event.
* @param timestamp The date/time of the event
* @param principal The user principal responsible
* @param timestamp the date/time of the event
* @param principal the user principal responsible
* @param type the event type
* @param data The event data
* @param data the event data
*/
public AuditEvent(Instant timestamp, String principal, String type,
Map<String, Object> data) {

View File

@@ -26,7 +26,7 @@ import org.springframework.util.Assert;
/**
* Abstract base class for {@link ExposableEndpoint} implementations.
*
* @param <O> The operation type.
* @param <O> the operation type.
* @author Phillip Webb
* @since 2.0.0
*/

View File

@@ -28,7 +28,7 @@ import org.springframework.util.Assert;
* Abstract base class for {@link ExposableEndpoint endpoints} discovered by a
* {@link EndpointDiscoverer}.
*
* @param <O> The operation type
* @param <O> the operation type
* @author Phillip Webb
* @since 2.0.0
*/

View File

@@ -22,7 +22,7 @@ import org.springframework.boot.actuate.endpoint.Operation;
/**
* An {@link ExposableEndpoint endpoint} discovered by an {@link EndpointDiscoverer}.
*
* @param <O> The operation type
* @param <O> the operation type
* @author Phillip Webb
* @since 2.0.0
*/

View File

@@ -40,7 +40,7 @@ import org.springframework.core.annotation.AnnotationAttributes;
* Factory to create an {@link Operation} for annotated methods on an
* {@link Endpoint @Endpoint} or {@link EndpointExtension @EndpointExtension}.
*
* @param <O> The operation type
* @param <O> the operation type
* @author Andy Wilkinson
* @author Stephane Nicoll
* @author Phillip Webb

View File

@@ -54,8 +54,8 @@ import org.springframework.util.StringUtils;
* {@link Endpoint @Endpoint} beans and {@link EndpointExtension @EndpointExtension} beans
* in an application context.
*
* @param <E> The endpoint type
* @param <O> The operation type
* @param <E> the endpoint type
* @param <O> the operation type
* @author Andy Wilkinson
* @author Stephane Nicoll
* @author Phillip Webb

View File

@@ -24,7 +24,7 @@ import org.springframework.cache.Cache;
/**
* Provide a {@link MeterBinder} based on a {@link Cache}.
*
* @param <C> The cache type
* @param <C> the cache type
* @author Stephane Nicoll
* @since 2.0.0
*/

View File

@@ -69,8 +69,8 @@ public class RouterFunctionMetrics {
/**
* Returns a new {@link RouterFunctionMetrics} instance with the specified default
* tags.
* @param defaultTags Generate a list of tags to apply to the timer.
* {@code ServerResponse} may be null.
* @param defaultTags function to generate a list of tags to apply to the timer
* {@code ServerResponse} may be null
* @return {@code this} for further configuration
*/
public RouterFunctionMetrics defaultTags(
@@ -94,8 +94,8 @@ public class RouterFunctionMetrics {
/**
* Creates a {@code method} tag from the method of the given {@code request}.
* @param request The HTTP request.
* @return A "method" tag whose value is a capitalized method (e.g. GET).
* @param request the HTTP request
* @return a "method" tag whose value is a capitalized method (e.g. GET)
*/
public static Tag getMethodTag(ServerRequest request) {
return Tag.of("method", request.method().toString());
@@ -103,8 +103,8 @@ public class RouterFunctionMetrics {
/**
* Creates a {@code status} tag from the status of the given {@code response}.
* @param response The HTTP response.
* @return A "status" tag whose value is the numeric status code.
* @param response the HTTP response
* @return a "status" tag whose value is the numeric status code
*/
public static Tag getStatusTag(ServerResponse response) {
return Tag.of("status", response.statusCode().toString());