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: *
security.basic.enabled: false
@EnableOAuth2Client
+ * refresh tokens you need to {@code @EnableOAuth2Client}
*/
@Configuration
@ConditionalOnMissingBean(OAuth2ClientConfiguration.class)
diff --git a/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/security/oauth2/client/OAuth2SsoCustomConfiguration.java b/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/security/oauth2/client/OAuth2SsoCustomConfiguration.java
index 92dd7e3c4f..aee8f3cb42 100644
--- a/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/security/oauth2/client/OAuth2SsoCustomConfiguration.java
+++ b/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/security/oauth2/client/OAuth2SsoCustomConfiguration.java
@@ -42,7 +42,7 @@ import org.springframework.util.ReflectionUtils;
/**
* Configuration for OAuth2 Single Sign On (SSO) when there is an existing
* {@link WebSecurityConfigurerAdapter} provided by the user and annotated with
- * @EnableOAuth2Sso
. The user-provided configuration is enhanced by adding an
+ * {@code @EnableOAuth2Sso}. The user-provided configuration is enhanced by adding an
* authentication filter and an authentication entry point.
*
* @author Dave Syer
diff --git a/spring-boot-cli/src/main/java/org/springframework/boot/cli/compiler/AstUtils.java b/spring-boot-cli/src/main/java/org/springframework/boot/cli/compiler/AstUtils.java
index dd7eb0fad0..3e95ac30ef 100644
--- a/spring-boot-cli/src/main/java/org/springframework/boot/cli/compiler/AstUtils.java
+++ b/spring-boot-cli/src/main/java/org/springframework/boot/cli/compiler/AstUtils.java
@@ -138,7 +138,7 @@ public abstract class AstUtils {
}
/**
- * Extract a top-level name
closure from inside this block if there is
+ * Extract a top-level {@code name} closure from inside this block if there is
* one, optionally removing it from the block at the same time.
* @param block a block statement (class definition)
* @param name the name to look for
diff --git a/spring-boot-cli/src/main/java/org/springframework/boot/cli/compiler/GroovyCompiler.java b/spring-boot-cli/src/main/java/org/springframework/boot/cli/compiler/GroovyCompiler.java
index 88d63bbbf2..56fb792cc6 100644
--- a/spring-boot-cli/src/main/java/org/springframework/boot/cli/compiler/GroovyCompiler.java
+++ b/spring-boot-cli/src/main/java/org/springframework/boot/cli/compiler/GroovyCompiler.java
@@ -55,7 +55,7 @@ import org.springframework.core.annotation.AnnotationAwareOrderComparator;
* features:
* META-INF/services/org.springframework.boot.cli.compiler.CompilerAutoConfiguration
+ * {@code META-INF/services/org.springframework.boot.cli.compiler.CompilerAutoConfiguration}
* (per the standard java {@link ServiceLoader} contract) and applied during compilation
* Looks in various places for a properties file to extract loader settings, defaulting to
- * application.properties
either on the current classpath or in the current
+ * {@code application.properties} either on the current classpath or in the current
* working directory. The name of the properties file can be changed by setting a System
- * property loader.config.name
(e.g. -Dloader.config.name=foo
- * will look for foo.properties
. If that file doesn't exist then tries
- * loader.config.location
(with allowed prefixes classpath:
and
- * file:
or any valid URL). Once that file is located turns it into
+ * property {@code loader.config.name} (e.g. {@code -Dloader.config.name=foo}
+ * will look for {@code foo.properties}. If that file doesn't exist then tries
+ * {@code loader.config.location} (with allowed prefixes {@code classpath:} and
+ * {@code file:} or any valid URL). Once that file is located turns it into
* Properties and extracts optional values (which can also be provided overridden as
* System properties in case the file doesn't exist):
*
loader.path
: a comma-separated list of directories to append to the
+ * lib
(i.e. a directory in the current working directory)loader.main
: the main method to delegate execution to once the class
+ * Defaults to {@code lib} (i.e. a directory in the current working directory)Start-Class
in a MANIFEST.MF
, if there is one in
+ * {@code Start-Class} in a {@code MANIFEST.MF}, if there is one in
* ${loader.home}/META-INF
.Start-Class
.
+ * {@code Start-Class}.
*/
public static final String MAIN = "loader.main";
diff --git a/spring-boot-tools/spring-boot-loader/src/main/java/org/springframework/boot/loader/util/SystemPropertyUtils.java b/spring-boot-tools/spring-boot-loader/src/main/java/org/springframework/boot/loader/util/SystemPropertyUtils.java
index 0fb63a0157..fa9d1c0fcf 100644
--- a/spring-boot-tools/spring-boot-loader/src/main/java/org/springframework/boot/loader/util/SystemPropertyUtils.java
+++ b/spring-boot-tools/spring-boot-loader/src/main/java/org/springframework/boot/loader/util/SystemPropertyUtils.java
@@ -167,8 +167,8 @@ public abstract class SystemPropertyUtils {
/**
* Search the System properties and environment variables for a value with the
- * provided key. Environment variables in UPPER_CASE
style are allowed
- * where System properties would normally be lower.case
.
+ * provided key. Environment variables in {@code UPPER_CASE} style are allowed
+ * where System properties would normally be {@code lower.case}.
* @param key the key to resolve
* @param defaultValue the default value
* @param text optional extra context for an error message if the key resolution fails
diff --git a/spring-boot/src/main/java/org/springframework/boot/bind/RelaxedDataBinder.java b/spring-boot/src/main/java/org/springframework/boot/bind/RelaxedDataBinder.java
index 16f458e1f6..a2a5837154 100644
--- a/spring-boot/src/main/java/org/springframework/boot/bind/RelaxedDataBinder.java
+++ b/spring-boot/src/main/java/org/springframework/boot/bind/RelaxedDataBinder.java
@@ -124,8 +124,8 @@ public class RelaxedDataBinder extends DataBinder {
/**
* Modify the property values so that period separated property paths are valid for
* map keys. Also creates new maps for properties of map type that are null (assuming
- * all maps are potentially nested). The standard bracket [...]
- * dereferencing is also accepted.
+ * all maps are potentially nested). The standard bracket {@code[...]} dereferencing
+ * is also accepted.
* @param propertyValues the property values
* @param target the target object
*/
diff --git a/spring-boot/src/main/java/org/springframework/boot/cloudfoundry/VcapApplicationListener.java b/spring-boot/src/main/java/org/springframework/boot/cloudfoundry/VcapApplicationListener.java
index 116d5f54cf..8043b3c02d 100644
--- a/spring-boot/src/main/java/org/springframework/boot/cloudfoundry/VcapApplicationListener.java
+++ b/spring-boot/src/main/java/org/springframework/boot/cloudfoundry/VcapApplicationListener.java
@@ -60,10 +60,10 @@ import org.springframework.util.StringUtils;
*
*
* These objects are flattened into properties. The VCAP_APPLICATION object goes straight
- * to vcap.application.*
in a fairly obvious way, and the VCAP_SERVICES
- * object is unwrapped so that it is a hash of objects with key equal to the service
- * instance name (e.g. "mysql" in the example above), and value equal to that instances
- * properties, and then flattened in the same way. E.g.
+ * to {@code vcap.application.*} in a fairly obvious way, and the VCAP_SERVICES object is
+ * unwrapped so that it is a hash of objects with key equal to the service instance name
+ * (e.g. "mysql" in the example above), and value equal to that instances properties, and
+ * then flattened in the same way. E.g.
*
* * vcap.application.instance_id: 2ce0ac627a6c8e47e936d829a3a47b5b diff --git a/spring-boot/src/main/java/org/springframework/boot/context/FileEncodingApplicationListener.java b/spring-boot/src/main/java/org/springframework/boot/context/FileEncodingApplicationListener.java index 1f35462b56..fb41678016 100644 --- a/spring-boot/src/main/java/org/springframework/boot/context/FileEncodingApplicationListener.java +++ b/spring-boot/src/main/java/org/springframework/boot/context/FileEncodingApplicationListener.java @@ -26,18 +26,18 @@ import org.springframework.core.Ordered; /** * An {@link ApplicationListener} that halts application startup if the system file * encoding does not match an expected value set in the environment. By default has no - * effect, but if you setspring.mandatory_file_encoding
(or some camelCase - * or UPPERCASE variant of that) to the name of a character encoding (e.g. "UTF-8") then - * this initializer throws an exception when thefile.encoding
System - * property does not equal it. + * effect, but if you set {@code spring.mandatory_file_encoding} (or some camelCase or + * UPPERCASE variant of that) to the name of a character encoding (e.g. "UTF-8") then this + * initializer throws an exception when the {@code file.encoding} System property does not + * equal it. * *- * The System property
file.encoding
is normally set by the JVM in response - * to theLANG
orLC_ALL
environment variables. It is used - * (along with other platform-dependent variables keyed off those environment variables) - * to encode JVM arguments as well as file names and paths. In most cases you can override - * the file encoding System property on the command line (with standard JVM features), but - * also consider setting theLANG
environment variable to an explicit + * The System property {@code file.encoding} is normally set by the JVM in response to the + * {@code LANG} or {@code LC_ALL} environment variables. It is used (along with other + * platform-dependent variables keyed off those environment variables) to encode JVM + * arguments as well as file names and paths. In most cases you can override the file + * encoding System property on the command line (with standard JVM features), but also + * consider setting the {@code LANG} environment variable to an explicit * character-encoding value (e.g. "en_GB.UTF-8"). * * @author Dave Syer diff --git a/spring-boot/src/main/java/org/springframework/boot/context/config/AnsiOutputApplicationListener.java b/spring-boot/src/main/java/org/springframework/boot/context/config/AnsiOutputApplicationListener.java index 09614f6aed..fea52e4d93 100644 --- a/spring-boot/src/main/java/org/springframework/boot/context/config/AnsiOutputApplicationListener.java +++ b/spring-boot/src/main/java/org/springframework/boot/context/config/AnsiOutputApplicationListener.java @@ -25,8 +25,8 @@ import org.springframework.core.Ordered; /** * An {@link ApplicationListener} that configures {@link AnsiOutput} depending on the the - * value of the propertyspring.output.ansi.enabled
. See {@link Enabled} for - * valid values. + * value of the property {@code spring.output.ansi.enabled}. See {@link Enabled} for valid + * values. * * @author Raphael von der GrĂ¼n * @since 1.2.0 diff --git a/spring-boot/src/main/java/org/springframework/boot/context/embedded/AnnotationConfigEmbeddedWebApplicationContext.java b/spring-boot/src/main/java/org/springframework/boot/context/embedded/AnnotationConfigEmbeddedWebApplicationContext.java index 9f465b9b04..2dee3dc8f1 100644 --- a/spring-boot/src/main/java/org/springframework/boot/context/embedded/AnnotationConfigEmbeddedWebApplicationContext.java +++ b/spring-boot/src/main/java/org/springframework/boot/context/embedded/AnnotationConfigEmbeddedWebApplicationContext.java @@ -22,20 +22,19 @@ import org.springframework.context.annotation.AnnotatedBeanDefinitionReader; import org.springframework.context.annotation.AnnotationConfigUtils; import org.springframework.context.annotation.AnnotationScopeMetadataResolver; import org.springframework.context.annotation.ClassPathBeanDefinitionScanner; -import org.springframework.context.annotation.Configuration; import org.springframework.context.annotation.ScopeMetadataResolver; import org.springframework.core.env.ConfigurableEnvironment; +import org.springframework.stereotype.Component; import org.springframework.util.Assert; import org.springframework.web.context.support.AnnotationConfigWebApplicationContext; /** * {@link EmbeddedWebApplicationContext} that accepts annotated classes as input - in - * particular {@link org.springframework.context.annotation.Configuration - *@Configuration
}-annotated classes, but also plain - * {@link org.springframework.stereotype.Component@Component
} classes and - * JSR-330 compliant classes using {@code javax.inject} annotations. Allows for - * registering classes one by one (specifying class names as config location) as well as - * for classpath scanning (specifying base packages as config location). + * particular {@link org.springframework.context.annotation.Configuration @Configuration} + * -annotated classes, but also plain {@link Component @Component} classes and JSR-330 + * compliant classes using {@code javax.inject} annotations. Allows for registering + * classes one by one (specifying class names as config location) as well as for classpath + * scanning (specifying base packages as config location). ** Note: In case of multiple {@code @Configuration} classes, later {@code @Bean} * definitions will override ones defined in earlier loaded files. This can be leveraged @@ -72,8 +71,8 @@ public class AnnotationConfigEmbeddedWebApplicationContext extends * Create a new {@link AnnotationConfigEmbeddedWebApplicationContext}, deriving bean * definitions from the given annotated classes and automatically refreshing the * context. - * @param annotatedClasses one or more annotated classes, e.g. {@link Configuration - *
@Configuration
} classes + * @param annotatedClasses one or more annotated classes, e.g. {@code @Configuration} + * classes */ public AnnotationConfigEmbeddedWebApplicationContext(Class>... annotatedClasses) { this(); @@ -148,8 +147,8 @@ public class AnnotationConfigEmbeddedWebApplicationContext extends ** Calls to {@link #register} are idempotent; adding the same annotated class more * than once has no additional effect. - * @param annotatedClasses one or more annotated classes, e.g. {@link Configuration - *
@Configuration
} classes + * @param annotatedClasses one or more annotated classes, e.g. {@code @Configuration} + * classes * @see #scan(String...) * @see #refresh() */ diff --git a/spring-boot/src/main/java/org/springframework/boot/context/embedded/ConfigurableEmbeddedServletContainer.java b/spring-boot/src/main/java/org/springframework/boot/context/embedded/ConfigurableEmbeddedServletContainer.java index a9a9445e7b..e5074b182c 100644 --- a/spring-boot/src/main/java/org/springframework/boot/context/embedded/ConfigurableEmbeddedServletContainer.java +++ b/spring-boot/src/main/java/org/springframework/boot/context/embedded/ConfigurableEmbeddedServletContainer.java @@ -81,10 +81,10 @@ public interface ConfigurableEmbeddedServletContainer { /** * The class name for the jsp servlet if used. If - * {@link #setRegisterJspServlet(boolean)registerJspServlet
} is true - * and this class is on the classpath then it will be registered. Since both - * Tomcat and Jetty use Jasper for their JSP implementation the default is - *org.apache.jasper.servlet.JspServlet
. + * {@link #setRegisterJspServlet(boolean) registerJspServlet} is true and this + * class is on the classpath then it will be registered. Since both Tomcat and Jetty + * use Jasper for their JSP implementation the default is + * {@code org.apache.jasper.servlet.JspServlet}. * @param jspServletClassName the class name for the JSP servlet if used * @deprecated in 1.3.0 in favor of {@link JspServlet#setClassName(String)} * @see #setJspServlet diff --git a/spring-boot/src/main/java/org/springframework/boot/context/embedded/EmbeddedServletContainerCustomizer.java b/spring-boot/src/main/java/org/springframework/boot/context/embedded/EmbeddedServletContainerCustomizer.java index 2441acb6db..726063d9ec 100644 --- a/spring-boot/src/main/java/org/springframework/boot/context/embedded/EmbeddedServletContainerCustomizer.java +++ b/spring-boot/src/main/java/org/springframework/boot/context/embedded/EmbeddedServletContainerCustomizer.java @@ -27,7 +27,7 @@ import org.springframework.beans.factory.config.BeanPostProcessor; * {@link EmbeddedServletContainerCustomizerBeanPostProcessor} which is a * {@link BeanPostProcessor} (so called very early in the ApplicationContext lifecycle). * It might be safer to lookup dependencies lazily in the enclosing BeanFactory rather - * than injecting them with@Autowired
. + * than injecting them with {@code @Autowired}. * * @author Dave Syer * @see EmbeddedServletContainerCustomizerBeanPostProcessor diff --git a/spring-boot/src/main/java/org/springframework/boot/context/properties/ConfigurationBeanFactoryMetaData.java b/spring-boot/src/main/java/org/springframework/boot/context/properties/ConfigurationBeanFactoryMetaData.java index 4566ce57db..83d8fa9f4a 100644 --- a/spring-boot/src/main/java/org/springframework/boot/context/properties/ConfigurationBeanFactoryMetaData.java +++ b/spring-boot/src/main/java/org/springframework/boot/context/properties/ConfigurationBeanFactoryMetaData.java @@ -31,8 +31,8 @@ import org.springframework.util.ReflectionUtils; import org.springframework.util.ReflectionUtils.MethodCallback; /** - * Utility class to memorize@Bean
definition meta data during initialization - * of the bean factory. + * Utility class to memorize {@code @Bean} definition meta data during initialization of + * the bean factory. * * @author Dave Syer * @since 1.1.0 diff --git a/spring-boot/src/main/java/org/springframework/boot/test/SpringApplicationContextLoader.java b/spring-boot/src/main/java/org/springframework/boot/test/SpringApplicationContextLoader.java index eebccb40b6..30b71aed96 100644 --- a/spring-boot/src/main/java/org/springframework/boot/test/SpringApplicationContextLoader.java +++ b/spring-boot/src/main/java/org/springframework/boot/test/SpringApplicationContextLoader.java @@ -62,8 +62,8 @@ import org.springframework.web.context.support.GenericWebApplicationContext; * {@code @WebAppConfiguration}) to indicate that you want to use a real servlet container * or {@code @WebAppConfiguration} alone to use a {@link MockServletContext}. *- * If
@ActiveProfiles
are provided in the test class they will be used to - * create the application context. + * If {@code @ActiveProfiles} are provided in the test class they will be used to create + * the application context. * * @author Dave Syer * @author Phillip Webb