Spring/spring-boot
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Fix checkstyle javadoc issues

Browse Source 
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
Download Patch File Download Diff File Expand all files Collapse all files

6
spring-boot-project/spring-boot/src/main/java/org/springframework/boot/EnvironmentConverter.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2012-2017 the original author or authors.
* Copyright 2012-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.
@@ -65,8 +65,8 @@ final class EnvironmentConverter {
* environment is already a {@code StandardEnvironment} and is not a
* {@link ConfigurableWebEnvironment} no conversion is performed and it is returned
* unchanged.
* @param environment The Environment to convert
* @return The converted Environment
* @param environment the Environment to convert
* @return the converted Environment
*/
StandardEnvironment convertToStandardEnvironmentIfNecessary(
ConfigurableEnvironment environment) {

2
spring-boot-project/spring-boot/src/main/java/org/springframework/boot/SpringApplication.java
View File

@@ -1001,7 +1001,7 @@ public class SpringApplication {
/**
* Sets the {@link Banner} instance which will be used to print the banner when no
* static banner file is provided.
* @param banner The Banner instance to use
* @param banner the Banner instance to use
*/
public void setBanner(Banner banner) {
this.banner = banner;

6
spring-boot-project/spring-boot/src/main/java/org/springframework/boot/builder/SpringApplicationBuilder.java
View File

@@ -94,8 +94,8 @@ public class SpringApplicationBuilder {
* Creates a new {@link org.springframework.boot.SpringApplication} instances from the
* given sources. Subclasses may override in order to provide a custom subclass of
* {@link org.springframework.boot.SpringApplication}
* @param sources The sources
* @return The {@link org.springframework.boot.SpringApplication} instance
* @param sources the sources
* @return the {@link org.springframework.boot.SpringApplication} instance
* @since 1.1.0
*/
protected SpringApplication createSpringApplication(Class<?>... sources) {
@@ -326,7 +326,7 @@ public class SpringApplicationBuilder {
/**
* Sets the {@link Banner} instance which will be used to print the banner when no
* static banner file is provided.
* @param banner The banner to use
* @param banner the banner to use
* @return the current builder
*/
public SpringApplicationBuilder banner(Banner banner) {

2
spring-boot-project/spring-boot/src/main/java/org/springframework/boot/context/properties/bind/AggregateBinder.java
View File

@@ -92,7 +92,7 @@ abstract class AggregateBinder<T> {
/**
* Internal class used to supply the aggregate and cache the value.
*
* @param <T> The aggregate type
* @param <T> the aggregate type
*/
protected static class AggregateSupplier<T> {

2
spring-boot-project/spring-boot/src/main/java/org/springframework/boot/context/properties/bind/BeanBinder.java
View File

@@ -34,7 +34,7 @@ interface BeanBinder {
* @param target the bindable to bind
* @param context the bind context
* @param propertyBinder property binder
* @param <T> The source type
* @param <T> the source type
* @return a bound instance or {@code null}
*/
<T> T bind(ConfigurationPropertyName name, Bindable<T> target, Context context,

8
spring-boot-project/spring-boot/src/main/java/org/springframework/boot/context/properties/bind/BindResult.java
View File

@@ -29,7 +29,7 @@ import org.springframework.util.ObjectUtils;
* A container object to return result of a {@link Binder} bind operation. May contain
* either a successfully bound object or an empty result.
*
* @param <T> The result type
* @param <T> the result type
* @author Phillip Webb
* @author Madhura Bhave
* @since 2.0.0
@@ -81,7 +81,7 @@ public final class BindResult<T> {
/**
* Apply the provided mapping function to the bound value, or return an updated
* unbound result if no value has been bound.
* @param <U> The type of the result of the mapping function
* @param <U> the type of the result of the mapping function
* @param mapper a mapping function to apply to the bound value. The mapper will not
* be invoked if no value has been bound.
* @return an {@code BindResult} describing the result of applying a mapping function
@@ -127,8 +127,8 @@ public final class BindResult<T> {
/**
* Return the object that was bound, or throw an exception to be created by the
* provided supplier if no value has been bound.
* @param <X> Type of the exception to be thrown
* @param exceptionSupplier The supplier which will return the exception to be thrown
* @param <X> the type of the exception to be thrown
* @param exceptionSupplier the supplier which will return the exception to be thrown
* @return the present value
* @throws X if there is no value present
*/

8
spring-boot-project/spring-boot/src/main/java/org/springframework/boot/context/properties/bind/Bindable.java
View File

@@ -31,7 +31,7 @@ import org.springframework.util.ObjectUtils;
/**
* Source that can be bound by a {@link Binder}.
*
* @param <T> The source type
* @param <T> the source type
* @author Phillip Webb
* @author Madhura Bhave
* @since 2.0.0
@@ -179,7 +179,7 @@ public final class Bindable<T> {
/**
* Create a new {@link Bindable} of the type of the specified instance with an
* existing value equal to the instance.
* @param <T> The source type
* @param <T> the source type
* @param instance the instance (must not be {@code null})
* @return a {@link Bindable} instance
* @see #of(ResolvableType)
@@ -194,7 +194,7 @@ public final class Bindable<T> {
/**
* Create a new {@link Bindable} of the specified type.
* @param <T> The source type
* @param <T> the source type
* @param type the type (must not be {@code null})
* @return a {@link Bindable} instance
* @see #of(ResolvableType)
@@ -238,7 +238,7 @@ public final class Bindable<T> {
/**
* Create a new {@link Bindable} of the specified type.
* @param <T> The source type
* @param <T> the source type
* @param type the type (must not be {@code null})
* @return a {@link Bindable} instance
* @see #of(Class)

2
spring-boot-project/spring-boot/src/main/java/org/springframework/boot/context/properties/bind/IndexedElementsBinder.java
View File

@@ -57,7 +57,7 @@ abstract class IndexedElementsBinder<T> extends AggregateBinder<T> {
/**
* Bind indexed elements to the supplied collection.
* @param name The name of the property to bind
* @param name the name of the property to bind
* @param target the target bindable
* @param elementBinder the binder to use for elements
* @param aggregateType the aggregate type, may be a collection or an array

2
spring-boot-project/spring-boot/src/main/java/org/springframework/boot/env/SpringApplicationJsonEnvironmentPostProcessor.java vendored
View File

@@ -115,7 +115,7 @@ public class SpringApplicationJsonEnvironmentPostProcessor
/**
* Flatten the map keys using period separator.
* @param map The map that should be flattened
* @param map the map that should be flattened
* @return the flattened map
*/
private Map<String, Object> flatten(Map<String, Object> map) {

2
spring-boot-project/spring-boot/src/main/java/org/springframework/boot/logging/AbstractLoggingSystem.java
View File

@@ -186,7 +186,7 @@ public abstract class AbstractLoggingSystem extends LoggingSystem {
/**
* Maintains a mapping between native levels and {@link LogLevel}.
*
* @param <T> The native level type
* @param <T> the native level type
*/
protected static class LogLevels<T> {

2
spring-boot-project/spring-boot/src/main/java/org/springframework/boot/logging/LoggingSystem.java
View File

@@ -146,7 +146,7 @@ public abstract class LoggingSystem {
/**
* Detect and return the logging system in use. Supports Logback and Java Logging.
* @param classLoader the classloader
* @return The logging system
* @return the logging system
*/
public static LoggingSystem get(ClassLoader classLoader) {
String loggingSystem = System.getProperty(SYSTEM_PROPERTY);

4
spring-boot-project/spring-boot/src/main/java/org/springframework/boot/origin/OriginLookup.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2012-2017 the original author or authors.
* Copyright 2012-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.
@@ -20,7 +20,7 @@ package org.springframework.boot.origin;
* An interface that may be implemented by an object that can lookup {@link Origin}
* information from a given key. Can be used to add origin support to existing classes.
*
* @param <K> The lookup key type
* @param <K> the lookup key type
* @author Phillip Webb
* @since 2.0.0
*/

4
spring-boot-project/spring-boot/src/main/java/org/springframework/boot/orm/jpa/EntityManagerFactoryBuilder.java
View File

@@ -61,7 +61,7 @@ public class EntityManagerFactoryBuilder {
* Create a new instance passing in the common pieces that will be shared if multiple
* EntityManagerFactory instances are created.
* @param jpaVendorAdapter a vendor adapter
* @param jpaProperties JPA properties to be passed to the persistence provider.
* @param jpaProperties the JPA properties to be passed to the persistence provider
* @param persistenceUnitManager optional source of persistence unit information (can
* be null)
*/
@@ -74,7 +74,7 @@ public class EntityManagerFactoryBuilder {
* Create a new instance passing in the common pieces that will be shared if multiple
* EntityManagerFactory instances are created.
* @param jpaVendorAdapter a vendor adapter
* @param jpaProperties JPA properties to be passed to the persistence provider.
* @param jpaProperties the JPA properties to be passed to the persistence provider
* @param persistenceUnitManager optional source of persistence unit information (can
* be null)
* @param persistenceUnitRootLocation the persistence unit root location to use as a

2
spring-boot-project/spring-boot/src/main/java/org/springframework/boot/security/reactive/ApplicationContextServerWebExchangeMatcher.java
View File

@@ -32,7 +32,7 @@ import org.springframework.web.server.ServerWebExchange;
* {@link AutowireCapableBeanFactory#createBean(Class, int, boolean) create a new bean}
* that is autowired in the usual way.
*
* @param <C> The type of the context that the match method actually needs to use. Can be
* @param <C> the type of the context that the match method actually needs to use. Can be
* an {@link ApplicationContext} or a class of an {@link ApplicationContext#getBean(Class)
* existing bean}.
* @author Madhura Bhave

2
spring-boot-project/spring-boot/src/main/java/org/springframework/boot/security/servlet/ApplicationContextRequestMatcher.java
View File

@@ -33,7 +33,7 @@ import org.springframework.web.context.support.WebApplicationContextUtils;
* {@link AutowireCapableBeanFactory#createBean(Class, int, boolean) create a new bean}
* that is autowired in the usual way.
*
* @param <C> The type of the context that the match method actually needs to use. Can be
* @param <C> the type of the context that the match method actually needs to use. Can be
* an {@link ApplicationContext} or a class of an {@link ApplicationContext#getBean(Class)
* existing bean}.
* @author Phillip Webb

2
spring-boot-project/spring-boot/src/main/java/org/springframework/boot/util/LambdaSafe.java
View File

@@ -368,7 +368,7 @@ public final class LambdaSafe {
* the callback wasn't suitable. Similar in design to {@link Optional} but allows for
* {@code null} as a valid value.
*
* @param <R> The result type
* @param <R> the result type
*/
public static final class InvocationResult<R> {

4
spring-boot-project/spring-boot/src/main/java/org/springframework/boot/web/server/AbstractConfigurableWebServerFactory.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2012-2017 the original author or authors.
* Copyright 2012-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.
@@ -166,7 +166,7 @@ public abstract class AbstractConfigurableWebServerFactory
/**
* Return the absolute temp dir for given web server.
* @param prefix server name
* @return The temp dir for given server.
* @return the temp dir for given server.
*/
protected final File createTempDir(String prefix) {
try {

2
spring-boot-project/spring-boot/src/main/java/org/springframework/boot/web/server/WebServerFactoryCustomizer.java
View File

@@ -29,7 +29,7 @@ import org.springframework.beans.factory.config.BeanPostProcessor;
* It might be safer to lookup dependencies lazily in the enclosing BeanFactory rather
* than injecting them with {@code @Autowired}.
*
* @param <T> The configurable web server factory
* @param <T> the configurable web server factory
* @author Phillip Webb
* @author Dave Syer
* @author Brian Clozel

2
spring-boot-project/spring-boot/src/main/java/org/springframework/boot/web/servlet/DynamicRegistrationBean.java
View File

@@ -33,7 +33,7 @@ import org.springframework.util.StringUtils;
* Base class for Servlet 3.0+ {@link javax.servlet.Registration.Dynamic dynamic} based
* registration beans.
*
* @param <D> The dynamic registration result
* @param <D> the dynamic registration result
* @author Phillip Webb
* @since 2.0.0
*/