From f385a1cb1130b4131e3a01ca3ee8c38aedd4be3f Mon Sep 17 00:00:00 2001 From: Johnny Lim Date: Thu, 24 May 2018 00:01:19 +0900 Subject: [PATCH] Polish Closes gh-13243 --- .../actuate/autoconfigure/metrics/jdbc/package-info.java | 2 +- .../actuate/endpoint/annotation/DiscoveredEndpoint.java | 2 +- .../endpoint/annotation/DiscoveredOperationMethod.java | 2 +- .../actuate/endpoint/annotation/EndpointDiscoverer.java | 2 +- .../boot/actuate/endpoint/jmx/MBeanInfoFactory.java | 2 +- .../elasticsearch/ElasticsearchDataAutoConfiguration.java | 4 ++-- .../boot/autoconfigure/domain/EntityScanner.java | 2 +- .../lombok/LombokAccessLevelOverwriteDataProperties.java | 4 ++-- .../source/SpringIterableConfigurationPropertySource.java | 2 +- .../main/java/org/springframework/boot/origin/Origin.java | 2 +- .../org/springframework/boot/origin/OriginTrackedValue.java | 4 ++-- .../springframework/boot/origin/PropertySourceOrigin.java | 6 +++--- .../source/SpringConfigurationPropertySourceTests.java | 4 ++-- .../SpringIterableConfigurationPropertySourceTests.java | 4 ++-- 14 files changed, 21 insertions(+), 21 deletions(-) diff --git a/spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/metrics/jdbc/package-info.java b/spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/metrics/jdbc/package-info.java index a3db7bed278..f0250985a5d 100644 --- a/spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/metrics/jdbc/package-info.java +++ b/spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/metrics/jdbc/package-info.java @@ -15,6 +15,6 @@ */ /** - * Auto-configuration for JDBC metrics. + * Auto-configuration for JPA metrics. */ package org.springframework.boot.actuate.autoconfigure.metrics.jdbc; diff --git a/spring-boot-project/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/endpoint/annotation/DiscoveredEndpoint.java b/spring-boot-project/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/endpoint/annotation/DiscoveredEndpoint.java index 673fb898bf8..73a917b98c4 100644 --- a/spring-boot-project/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/endpoint/annotation/DiscoveredEndpoint.java +++ b/spring-boot-project/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/endpoint/annotation/DiscoveredEndpoint.java @@ -20,7 +20,7 @@ import org.springframework.boot.actuate.endpoint.ExposableEndpoint; import org.springframework.boot.actuate.endpoint.Operation; /** - * An {@link ExposableEndpoint endpoint} discovered by a {@link EndpointDiscoverer}. + * An {@link ExposableEndpoint endpoint} discovered by an {@link EndpointDiscoverer}. * * @param The operation type * @author Phillip Webb diff --git a/spring-boot-project/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/endpoint/annotation/DiscoveredOperationMethod.java b/spring-boot-project/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/endpoint/annotation/DiscoveredOperationMethod.java index 3ee20e10fdd..8eb3b2b8dfa 100644 --- a/spring-boot-project/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/endpoint/annotation/DiscoveredOperationMethod.java +++ b/spring-boot-project/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/endpoint/annotation/DiscoveredOperationMethod.java @@ -27,7 +27,7 @@ import org.springframework.core.annotation.AnnotationAttributes; import org.springframework.util.Assert; /** - * A {@link OperationMethod} discovered by a {@link EndpointDiscoverer}. + * An {@link OperationMethod} discovered by an {@link EndpointDiscoverer}. * * @author Phillip Webb * @since 2.0.0 diff --git a/spring-boot-project/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/endpoint/annotation/EndpointDiscoverer.java b/spring-boot-project/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/endpoint/annotation/EndpointDiscoverer.java index d66451ede43..f174650df3f 100644 --- a/spring-boot-project/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/endpoint/annotation/EndpointDiscoverer.java +++ b/spring-boot-project/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/endpoint/annotation/EndpointDiscoverer.java @@ -354,7 +354,7 @@ public abstract class EndpointDiscoverer, O exten DiscoveredOperationMethod operationMethod, OperationInvoker invoker); /** - * Create a {@link OperationKey} for the given operation. + * Create an {@link OperationKey} for the given operation. * @param operation the source operation * @return the operation key */ diff --git a/spring-boot-project/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/endpoint/jmx/MBeanInfoFactory.java b/spring-boot-project/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/endpoint/jmx/MBeanInfoFactory.java index 4b9ca728097..953625a8731 100644 --- a/spring-boot-project/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/endpoint/jmx/MBeanInfoFactory.java +++ b/spring-boot-project/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/endpoint/jmx/MBeanInfoFactory.java @@ -30,7 +30,7 @@ import javax.management.modelmbean.ModelMBeanOperationInfo; import org.springframework.boot.actuate.endpoint.OperationType; /** - * Factory to create {@link MBeanInfo} from a {@link ExposableJmxEndpoint}. + * Factory to create {@link MBeanInfo} from an {@link ExposableJmxEndpoint}. * * @author Stephane Nicoll * @author Phillip Webb diff --git a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/data/elasticsearch/ElasticsearchDataAutoConfiguration.java b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/data/elasticsearch/ElasticsearchDataAutoConfiguration.java index 048ff4be1c7..bdcbe35ede4 100644 --- a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/data/elasticsearch/ElasticsearchDataAutoConfiguration.java +++ b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/data/elasticsearch/ElasticsearchDataAutoConfiguration.java @@ -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. @@ -35,7 +35,7 @@ import org.springframework.data.elasticsearch.repository.config.EnableElasticsea * {@link EnableAutoConfiguration Auto-configuration} for Spring Data's Elasticsearch * support. *

- * Registers a {@link ElasticsearchTemplate} if no other bean of the same type is + * Registers an {@link ElasticsearchTemplate} if no other bean of the same type is * configured. * * @author Artur Konczak diff --git a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/domain/EntityScanner.java b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/domain/EntityScanner.java index c48ca7d02ee..5291672720c 100644 --- a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/domain/EntityScanner.java +++ b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/domain/EntityScanner.java @@ -32,7 +32,7 @@ import org.springframework.util.ClassUtils; import org.springframework.util.StringUtils; /** - * An entity scanner that searches the classpath from a {@link EntityScan @EntityScan} + * An entity scanner that searches the classpath from an {@link EntityScan @EntityScan} * specified packages. * * @author Phillip Webb diff --git a/spring-boot-project/spring-boot-tools/spring-boot-configuration-processor/src/test/java/org/springframework/boot/configurationsample/lombok/LombokAccessLevelOverwriteDataProperties.java b/spring-boot-project/spring-boot-tools/spring-boot-configuration-processor/src/test/java/org/springframework/boot/configurationsample/lombok/LombokAccessLevelOverwriteDataProperties.java index f8fe880ca8f..fa9d16e4045 100644 --- a/spring-boot-project/spring-boot-tools/spring-boot-configuration-processor/src/test/java/org/springframework/boot/configurationsample/lombok/LombokAccessLevelOverwriteDataProperties.java +++ b/spring-boot-project/spring-boot-tools/spring-boot-configuration-processor/src/test/java/org/springframework/boot/configurationsample/lombok/LombokAccessLevelOverwriteDataProperties.java @@ -24,8 +24,8 @@ import lombok.Setter; import org.springframework.boot.configurationsample.ConfigurationProperties; /** - * Configuration properties using lombok @Data on element level and overwriting behaviour - * with @Getter und @Setter at field level. + * Configuration properties using Lombok @Data on element level and overwriting behaviour + * with @Getter and @Setter at field level. * * @author Jonas Keßler */ diff --git a/spring-boot-project/spring-boot/src/main/java/org/springframework/boot/context/properties/source/SpringIterableConfigurationPropertySource.java b/spring-boot-project/spring-boot/src/main/java/org/springframework/boot/context/properties/source/SpringIterableConfigurationPropertySource.java index 2a1017a0888..04ee92ff8b9 100644 --- a/spring-boot-project/spring-boot/src/main/java/org/springframework/boot/context/properties/source/SpringIterableConfigurationPropertySource.java +++ b/spring-boot-project/spring-boot/src/main/java/org/springframework/boot/context/properties/source/SpringIterableConfigurationPropertySource.java @@ -29,7 +29,7 @@ import org.springframework.core.env.SystemEnvironmentPropertySource; import org.springframework.util.ObjectUtils; /** - * {@link ConfigurationPropertySource} backed by a {@link EnumerablePropertySource}. + * {@link ConfigurationPropertySource} backed by an {@link EnumerablePropertySource}. * Extends {@link SpringConfigurationPropertySource} with full "relaxed" mapping support. * In order to use this adapter the underlying {@link PropertySource} must be fully * enumerable. A security restricted {@link SystemEnvironmentPropertySource} cannot be diff --git a/spring-boot-project/spring-boot/src/main/java/org/springframework/boot/origin/Origin.java b/spring-boot-project/spring-boot/src/main/java/org/springframework/boot/origin/Origin.java index 4d9c460af7d..c4a1d665582 100644 --- a/spring-boot-project/spring-boot/src/main/java/org/springframework/boot/origin/Origin.java +++ b/spring-boot-project/spring-boot/src/main/java/org/springframework/boot/origin/Origin.java @@ -35,7 +35,7 @@ public interface Origin { /** * Find the {@link Origin} that an object originated from. Checks if the source object - * is a {@link OriginProvider} and also searches exception stacks. + * is an {@link OriginProvider} and also searches exception stacks. * @param source the source object or {@code null} * @return an optional {@link Origin} */ diff --git a/spring-boot-project/spring-boot/src/main/java/org/springframework/boot/origin/OriginTrackedValue.java b/spring-boot-project/spring-boot/src/main/java/org/springframework/boot/origin/OriginTrackedValue.java index 499be39aac5..60f1cc71ee1 100644 --- a/spring-boot-project/spring-boot/src/main/java/org/springframework/boot/origin/OriginTrackedValue.java +++ b/spring-boot-project/spring-boot/src/main/java/org/springframework/boot/origin/OriginTrackedValue.java @@ -19,7 +19,7 @@ package org.springframework.boot.origin; import org.springframework.util.ObjectUtils; /** - * An wrapper for a {@link Object} value and {@link Origin}. + * A wrapper for an {@link Object} value and {@link Origin}. * * @author Madhura Bhave * @author Phillip Webb @@ -79,7 +79,7 @@ public class OriginTrackedValue implements OriginProvider { * the resulting {@link OriginTrackedValue}. * @param value the source value * @param origin the origin - * @return a {@link OriginTrackedValue} or {@code null} if the source value was + * @return an {@link OriginTrackedValue} or {@code null} if the source value was * {@code null}. */ public static OriginTrackedValue of(Object value, Origin origin) { diff --git a/spring-boot-project/spring-boot/src/main/java/org/springframework/boot/origin/PropertySourceOrigin.java b/spring-boot-project/spring-boot/src/main/java/org/springframework/boot/origin/PropertySourceOrigin.java index a5c85c7c29f..f40ced02155 100644 --- a/spring-boot-project/spring-boot/src/main/java/org/springframework/boot/origin/PropertySourceOrigin.java +++ b/spring-boot-project/spring-boot/src/main/java/org/springframework/boot/origin/PropertySourceOrigin.java @@ -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. @@ -67,8 +67,8 @@ public class PropertySourceOrigin implements Origin { } /** - * Get a {@link Origin} for the given {@link PropertySource} and {@code propertyName}. - * Will either return an {@link OriginLookup} result or a + * Get an {@link Origin} for the given {@link PropertySource} and + * {@code propertyName}. Will either return an {@link OriginLookup} result or a * {@link PropertySourceOrigin}. * @param propertySource the origin property source * @param name the property name diff --git a/spring-boot-project/spring-boot/src/test/java/org/springframework/boot/context/properties/source/SpringConfigurationPropertySourceTests.java b/spring-boot-project/spring-boot/src/test/java/org/springframework/boot/context/properties/source/SpringConfigurationPropertySourceTests.java index bdf483446fa..02d4cbcde28 100644 --- a/spring-boot-project/spring-boot/src/test/java/org/springframework/boot/context/properties/source/SpringConfigurationPropertySourceTests.java +++ b/spring-boot-project/spring-boot/src/test/java/org/springframework/boot/context/properties/source/SpringConfigurationPropertySourceTests.java @@ -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. @@ -160,7 +160,7 @@ public class SpringConfigurationPropertySourceTests { } /** - * Test {@link PropertySource} that's also a {@link OriginLookup}. + * Test {@link PropertySource} that's also an {@link OriginLookup}. */ private static class OriginCapablePropertySource extends PropertySource implements OriginLookup { diff --git a/spring-boot-project/spring-boot/src/test/java/org/springframework/boot/context/properties/source/SpringIterableConfigurationPropertySourceTests.java b/spring-boot-project/spring-boot/src/test/java/org/springframework/boot/context/properties/source/SpringIterableConfigurationPropertySourceTests.java index 4873cb4db10..fd9a9d59b00 100644 --- a/spring-boot-project/spring-boot/src/test/java/org/springframework/boot/context/properties/source/SpringIterableConfigurationPropertySourceTests.java +++ b/spring-boot-project/spring-boot/src/test/java/org/springframework/boot/context/properties/source/SpringIterableConfigurationPropertySourceTests.java @@ -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. @@ -158,7 +158,7 @@ public class SpringIterableConfigurationPropertySourceTests { } /** - * Test {@link PropertySource} that's also a {@link OriginLookup}. + * Test {@link PropertySource} that's also an {@link OriginLookup}. */ private static class OriginCapablePropertySource extends EnumerablePropertySource implements OriginLookup {