diff --git a/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/autoconfigure/CrshAutoConfiguration.java b/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/autoconfigure/CrshAutoConfiguration.java index 4452e123e8..1dbe3c784d 100644 --- a/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/autoconfigure/CrshAutoConfiguration.java +++ b/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/autoconfigure/CrshAutoConfiguration.java @@ -86,17 +86,16 @@ import org.springframework.util.StringUtils; * The default shell authentication method uses a username and password combination. If no * configuration is provided the default username is 'user' and the password will be * printed to console during application startup. Those default values can be overridden - * by using shell.auth.simple.username and - * shell.auth.simple.password. + * by using {@code shell.auth.simple.username} and {@code shell.auth.simple.password}. *

* If a Spring Security {@link AuthenticationManager} is detected, this configuration will * create a {@link CRaSHPlugin} to forward shell authentication requests to Spring - * Security. This authentication method will get enabled if shell.auth is set - * to spring or if no explicit shell.auth is provided and a + * Security. This authentication method will get enabled if {@code shell.auth} is set to + * {@code spring} or if no explicit {@code shell.auth} is provided and a * {@link AuthenticationManager} is available. In the latter case shell access will be * restricted to users having roles that match those configured in * {@link ManagementServerProperties}. Required roles can be overridden by - * shell.auth.spring.roles. + * {@code shell.auth.spring.roles}. *

* To add customizations to the shell simply define beans of type {@link CRaSHPlugin} in * the application context. Those beans will get auto detected during startup and @@ -106,9 +105,9 @@ import org.springframework.util.StringUtils; *

* Additional shell commands can be implemented using the guide and documentation at crashub.org. By default Boot will search for commands - * using the following classpath scanning pattern classpath*:/commands/**. To - * add different locations or override the default use - * shell.command_path_patterns in your application configuration. + * using the following classpath scanning pattern {@code classpath*:/commands/**}. To add + * different locations or override the default use {@code shell.command_path_patterns} in + * your application configuration. * * @author Christian Dupuis * @see ShellProperties diff --git a/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/autoconfigure/JolokiaAutoConfiguration.java b/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/autoconfigure/JolokiaAutoConfiguration.java index 3cfe63c42f..32c473d8b5 100644 --- a/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/autoconfigure/JolokiaAutoConfiguration.java +++ b/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/autoconfigure/JolokiaAutoConfiguration.java @@ -40,11 +40,11 @@ import org.springframework.context.annotation.Configuration; *

* This configuration will get automatically enabled as soon as the Jolokia * {@link AgentServlet} is on the classpath. To disable it set - * endpoints.jolokia.enabled: false or endpoints.enabled: false. + * {@code endpoints.jolokia.enabled: false} or {@code endpoints.enabled: false}. * *

* Additional configuration parameters for Jolokia can be provided by specifying - * jolokia.config.* properties. See the http://jolokia.org web site for more information on * supported configuration parameters. * diff --git a/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/autoconfigure/MetricRepositoryAutoConfiguration.java b/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/autoconfigure/MetricRepositoryAutoConfiguration.java index a16f75d325..605edf6ad6 100644 --- a/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/autoconfigure/MetricRepositoryAutoConfiguration.java +++ b/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/autoconfigure/MetricRepositoryAutoConfiguration.java @@ -63,12 +63,12 @@ import com.codahale.metrics.MetricRegistry; * {@link MetricRegistry} will be created and the default counter and gauge services will * switch to using it instead of the default repository. Users can create "special" * Dropwizard metrics by prefixing their metric names with the appropriate type (e.g. - * "histogram.*", "meter.*". "timer.*") and sending them to the GaugeService - * or CounterService. + * "histogram.*", "meter.*". "timer.*") and sending them to the {@code GaugeService} or + * {@code CounterService}. *

* By default all metric updates go to all {@link MetricWriter} instances in the * application context via a {@link MetricCopyExporter} firing every 5 seconds (disable - * this by setting spring.metrics.export.enabled=false). + * this by setting {@code spring.metrics.export.enabled=false}). * * @see GaugeService * @see CounterService diff --git a/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/endpoint/ConfigurationPropertiesReportEndpoint.java b/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/endpoint/ConfigurationPropertiesReportEndpoint.java index 947bf8995c..9dd1021ca6 100644 --- a/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/endpoint/ConfigurationPropertiesReportEndpoint.java +++ b/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/endpoint/ConfigurationPropertiesReportEndpoint.java @@ -64,8 +64,8 @@ import com.fasterxml.jackson.databind.ser.impl.SimpleFilterProvider; *

* To protect sensitive information from being exposed, certain property values are masked * if their names end with a set of configurable values (default "password" and "secret"). - * Configure property names by using endpoints.configprops.keys_to_sanitize - * in your Spring Boot application configuration. + * Configure property names by using {@code endpoints.configprops.keys_to_sanitize} in + * your Spring Boot application configuration. * * @author Christian Dupuis * @author Dave Syer diff --git a/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/endpoint/mvc/MvcEndpoint.java b/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/endpoint/mvc/MvcEndpoint.java index a63badc284..c7cb66a83e 100644 --- a/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/endpoint/mvc/MvcEndpoint.java +++ b/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/endpoint/mvc/MvcEndpoint.java @@ -20,10 +20,10 @@ import org.springframework.boot.actuate.endpoint.Endpoint; /** * A strategy for the MVC layer on top of an {@link Endpoint}. Implementations are allowed - * to use @RequestMapping and the full Spring MVC machinery, but should not - * use @Controller or @RequestMapping at the type level (since - * that would lead to a double mapping of paths, once by the regular MVC handler mappings - * and once by the {@link EndpointHandlerMapping}). + * to use {@code @RequestMapping} and the full Spring MVC machinery, but should not use + * {@code @Controller} or {@code @RequestMapping} at the type level (since that would lead + * to a double mapping of paths, once by the regular MVC handler mappings and once by the + * {@link EndpointHandlerMapping}). * * @author Dave Syer */ diff --git a/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/health/Health.java b/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/health/Health.java index ab9031d438..90f32ad162 100644 --- a/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/health/Health.java +++ b/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/health/Health.java @@ -184,7 +184,7 @@ public final class Health { } /** - * Create new Builder instance, setting status to given status. + * Create new Builder instance, setting status to given {@code status}. * @param status the {@link Status} to use */ public Builder(Status status) { @@ -194,8 +194,8 @@ public final class Health { } /** - * Create new Builder instance, setting status to given status and - * details to given details. + * Create new Builder instance, setting status to given {@code status} and details + * to given {@code details}. * @param status the {@link Status} to use * @param details the details {@link Map} to use */ @@ -217,7 +217,7 @@ public final class Health { } /** - * Record detail using key and value. + * Record detail using {@code key} and {@code value}. * @param key the detail key * @param data the detail data * @return this {@link Builder} instance @@ -271,7 +271,7 @@ public final class Health { } /** - * Set status to given statusCode. + * Set status to given {@code statusCode}. * @param statusCode the status code * @return this {@link Builder} instance */ diff --git a/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/metrics/jmx/DefaultMetricNamingStrategy.java b/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/metrics/jmx/DefaultMetricNamingStrategy.java index 8e7bdb12cb..7f454c9bf3 100644 --- a/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/metrics/jmx/DefaultMetricNamingStrategy.java +++ b/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/metrics/jmx/DefaultMetricNamingStrategy.java @@ -26,11 +26,11 @@ import org.springframework.jmx.export.naming.ObjectNamingStrategy; import org.springframework.util.StringUtils; /** - * MBean naming strategy for metric keys. A metric name of - * counter.foo.bar.spam translates to an object name with - * type=counter, name=foo and value=bar.spam. This - * results in a more or less pleasing view with no tweaks in jconsole or jvisualvm. The - * domain is copied from the input key and the type in the input key is discarded. + * MBean naming strategy for metric keys. A metric name of {@code counter.foo.bar.spam} + * translates to an object name with {@code type=counter}, {@code name=foo} and + * {@code value=bar.spam}. This results in a more or less pleasing view with no tweaks in + * jconsole or jvisualvm. The domain is copied from the input key and the type in the + * input key is discarded. * * @author Dave Syer * @since 1.3.0 diff --git a/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/metrics/jmx/JmxMetricWriter.java b/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/metrics/jmx/JmxMetricWriter.java index ec0507cb52..0b18cd42e3 100644 --- a/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/metrics/jmx/JmxMetricWriter.java +++ b/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/metrics/jmx/JmxMetricWriter.java @@ -38,8 +38,8 @@ import org.springframework.jmx.export.naming.ObjectNamingStrategy; * A {@link MetricWriter} for MBeans. Each metric is registered as an individual MBean, so * (for instance) it can be graphed and monitored. The object names are provided by an * {@link ObjectNamingStrategy}, where the default is a - * {@link DefaultMetricNamingStrategy} which provides type, name - * and value keys by splitting up the metric name on periods. + * {@link DefaultMetricNamingStrategy} which provides {@code type}, {@code name} and + * {@code value} keys by splitting up the metric name on periods. * * @author Dave Syer * @since 1.3.0 diff --git a/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/metrics/repository/redis/RedisMultiMetricRepository.java b/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/metrics/repository/redis/RedisMultiMetricRepository.java index 9c142538f3..7cd1199db3 100644 --- a/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/metrics/repository/redis/RedisMultiMetricRepository.java +++ b/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/metrics/repository/redis/RedisMultiMetricRepository.java @@ -35,7 +35,7 @@ import org.springframework.util.Assert; * {@link MultiMetricRepository} implementation backed by a redis store. Metric values are * stored as zset values and the timestamps as regular values, both against a key composed * of the group name prefixed with a constant prefix (default "spring.groups."). The group - * names are stored as a zset under "keys." + [prefix]. + * names are stored as a zset under "keys." + {@code [prefix]}. * * @author Dave Syer */ diff --git a/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/metrics/writer/PrefixMetricWriter.java b/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/metrics/writer/PrefixMetricWriter.java index b7fbbae502..4619e6a49d 100644 --- a/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/metrics/writer/PrefixMetricWriter.java +++ b/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/metrics/writer/PrefixMetricWriter.java @@ -38,7 +38,7 @@ public interface PrefixMetricWriter { /** * Increment the value of a metric (or decrement if the delta is negative). The name - * of the metric to increment is group + "." + delta.name. + * of the metric to increment is {@code group + "." + delta.name}. * @param group the name of the group * @param delta the amount to increment by */ diff --git a/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/flyway/FlywayDataSource.java b/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/flyway/FlywayDataSource.java index 7507b47adf..b0e3938280 100644 --- a/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/flyway/FlywayDataSource.java +++ b/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/flyway/FlywayDataSource.java @@ -26,7 +26,7 @@ import org.springframework.beans.factory.annotation.Qualifier; /** * Qualifier annotation for a DataSource to be injected in to Flyway. If used for a second - * data source, the other (main) one would normally be marked as @Primary. + * data source, the other (main) one would normally be marked as {@code @Primary}. * * @author Dave Syer * @since 1.1.0 diff --git a/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/jdbc/DataSourceBuilder.java b/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/jdbc/DataSourceBuilder.java index 65b519989a..e8ede348c6 100644 --- a/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/jdbc/DataSourceBuilder.java +++ b/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/jdbc/DataSourceBuilder.java @@ -33,7 +33,7 @@ import org.springframework.util.ClassUtils; * and so that there can be a fallback to an embedded database if one can be detected on * the classpath, only a small set of common configuration properties are supported. To * inject additional properties into the result you can downcast it, or use - * @ConfigurationProperties. + * {@code @ConfigurationProperties}. * * @author Dave Syer * @since 1.1.0 diff --git a/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/jmx/JmxAutoConfiguration.java b/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/jmx/JmxAutoConfiguration.java index 06e8c017da..9be6578a9b 100644 --- a/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/jmx/JmxAutoConfiguration.java +++ b/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/jmx/JmxAutoConfiguration.java @@ -45,7 +45,7 @@ import org.springframework.util.StringUtils; * {@link EnableAutoConfiguration Auto-configuration} to enable/disable Spring's * {@link EnableMBeanExport} mechanism based on configuration properties. *

- * To disable auto export of annotation beans set spring.jmx.enabled: false. + * To disable auto export of annotation beans set {@code spring.jmx.enabled: false}. * * @author Christian Dupuis */ diff --git a/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/orm/jpa/EntityManagerFactoryBuilder.java b/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/orm/jpa/EntityManagerFactoryBuilder.java index ddc91673b5..760d37273d 100644 --- a/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/orm/jpa/EntityManagerFactoryBuilder.java +++ b/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/orm/jpa/EntityManagerFactoryBuilder.java @@ -34,7 +34,7 @@ import org.springframework.util.ClassUtils; * {@link LocalContainerEntityManagerFactoryBean} through a fluent builder pattern. The * most common options are covered in the builder, but you can always manipulate the * product of the builder if you need more control, before returning it from a - * @Bean definition. + * {@code @Bean} definition. * * @author Dave Syer * @since 1.1.0 @@ -97,7 +97,7 @@ public class EntityManagerFactoryBuilder { } /** - * The names of packages to scan for @Entity annotations. + * The names of packages to scan for {@code @Entity} annotations. * @param packagesToScan packages to scan * @return the builder for fluent usage */ @@ -107,8 +107,7 @@ public class EntityManagerFactoryBuilder { } /** - * The classes whose packages should be scanned for @Entity - * annotations. + * The classes whose packages should be scanned for {@code @Entity} annotations. * @param basePackageClasses the classes to use * @return the builder for fluent usage */ diff --git a/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/security/FallbackWebSecurityAutoConfiguration.java b/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/security/FallbackWebSecurityAutoConfiguration.java index 0a1f79d77f..dbd8ac4427 100644 --- a/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/security/FallbackWebSecurityAutoConfiguration.java +++ b/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/security/FallbackWebSecurityAutoConfiguration.java @@ -28,10 +28,10 @@ import org.springframework.security.config.annotation.web.configuration.WebSecur /** * If the user explicitly disables the basic security features and forgets to - * @EnableWebSecurity, and yet still wants a bean of type + * {@code @EnableWebSecurity}, and yet still wants a bean of type * WebSecurityConfigurerAdapter, he is trying to use a custom security setup. The app * would fail in a confusing way without this shim configuration, which just helpfully - * defines an empty @EnableWebSecurity. + * defines an empty {@code @EnableWebSecurity}. * * @author Dave Syer */ diff --git a/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/security/SecurityAutoConfiguration.java b/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/security/SecurityAutoConfiguration.java index b30ed98fa3..7f442eb7d2 100644 --- a/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/security/SecurityAutoConfiguration.java +++ b/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/security/SecurityAutoConfiguration.java @@ -37,9 +37,9 @@ import org.springframework.security.config.annotation.web.configuration.WebSecur * random and printed on the console at INFO level during startup. In a webapp this * configuration also secures all web endpoints (except some well-known static resource) * locations with HTTP basic security. To replace all the default behaviour in a webapp - * provide a @Configuration with @EnableWebSecurity. To just add - * your own layer of application security in front of the defaults, add a - * @Configuration of type {@link WebSecurityConfigurerAdapter}. + * provide a {@code @Configuration} with {@code @EnableWebSecurity}. To just add your own + * layer of application security in front of the defaults, add a {@code @Configuration} of + * type {@link WebSecurityConfigurerAdapter}. * * @author Dave Syer * @author Andy Wilkinson diff --git a/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/security/SpringBootWebSecurityConfiguration.java b/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/security/SpringBootWebSecurityConfiguration.java index ef0dded064..8d79ea8d8e 100644 --- a/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/security/SpringBootWebSecurityConfiguration.java +++ b/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/security/SpringBootWebSecurityConfiguration.java @@ -67,17 +67,16 @@ import org.springframework.web.servlet.support.RequestDataValueProcessor; * ). Many aspects of the behavior can be controller with {@link SecurityProperties} via * externalized application properties (or via an bean definition of that type to set the * defaults). The user details for authentication are just placeholders - * (username=user, - * password=password) but can easily be customized by providing a bean definition - * of type {@link AuthenticationManager}. Also provides audit logging of authentication - * events. + * {@code (username=user, password=password)} but can easily be customized by providing a + * bean definition of type {@link AuthenticationManager}. Also provides audit logging of + * authentication events. *

* Some common simple customizations: *