Fix Java 8 Javadoc compatibility

Update Javadocs to fix errors caused by Java 8 aggressive linting.

Fixes gh-2233

eclipse/org.eclipse.jdt.core.prefs

@@ -52,10 +52,10 @@ org.eclipse.jdt.core.compiler.problem.missingJavadocComments=ignore
 org.eclipse.jdt.core.compiler.problem.missingJavadocCommentsOverriding=disabled
 org.eclipse.jdt.core.compiler.problem.missingJavadocCommentsVisibility=public
 org.eclipse.jdt.core.compiler.problem.missingJavadocTagDescription=return_tag
-org.eclipse.jdt.core.compiler.problem.missingJavadocTags=ignore
+org.eclipse.jdt.core.compiler.problem.missingJavadocTags=warning
 org.eclipse.jdt.core.compiler.problem.missingJavadocTagsMethodTypeParameters=disabled
 org.eclipse.jdt.core.compiler.problem.missingJavadocTagsOverriding=disabled
-org.eclipse.jdt.core.compiler.problem.missingJavadocTagsVisibility=private
+org.eclipse.jdt.core.compiler.problem.missingJavadocTagsVisibility=default
 org.eclipse.jdt.core.compiler.problem.missingOverrideAnnotation=ignore
 org.eclipse.jdt.core.compiler.problem.missingOverrideAnnotationForInterfaceMethodImplementation=enabled
 org.eclipse.jdt.core.compiler.problem.missingSerialVersion=ignore

spring-boot-actuator/src/main/java/org/springframework/boot/actuate/audit/AuditEvent.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2013 the original author or authors.
+ * Copyright 2012-2015 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.
@@ -103,6 +103,7 @@ public class AuditEvent implements Serializable {
 
 	/**
 	 * Returns the date/time that the even was logged.
+	 * @return the time stamp
 	 */
 	public Date getTimestamp() {
 		return this.timestamp;
@@ -110,6 +111,7 @@ public class AuditEvent implements Serializable {
 
 	/**
 	 * Returns the user principal responsible for the event or {@code null}.
+	 * @return the principal or {@code null}
 	 */
 	public String getPrincipal() {
 		return this.principal;
@@ -117,6 +119,7 @@ public class AuditEvent implements Serializable {
 
 	/**
 	 * Returns the type of event.
+	 * @return the event type
 	 */
 	public String getType() {
 		return this.type;
@@ -124,6 +127,7 @@ public class AuditEvent implements Serializable {
 
 	/**
 	 * Returns the event data.
+	 * @return the event data
 	 */
 	public Map<String, Object> getData() {
 		return this.data;

spring-boot-actuator/src/main/java/org/springframework/boot/actuate/audit/listener/AuditApplicationEvent.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2013 the original author or authors.
+ * Copyright 2012-2015 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,6 +35,9 @@ public class AuditApplicationEvent extends ApplicationEvent {
 	/**
 	 * Create a new {@link AuditApplicationEvent} that wraps a newly created
 	 * {@link AuditEvent}.
+	 * @param principal the principal
+	 * @param type the event type
+	 * @param data the event data
 	 * @see AuditEvent#AuditEvent(String, String, Map)
 	 */
 	public AuditApplicationEvent(String principal, String type, Map<String, Object> data) {
@@ -44,6 +47,9 @@ public class AuditApplicationEvent extends ApplicationEvent {
 	/**
 	 * Create a new {@link AuditApplicationEvent} that wraps a newly created
 	 * {@link AuditEvent}.
+	 * @param principal the principal
+	 * @param type the event type
+	 * @param data the event data
 	 * @see AuditEvent#AuditEvent(String, String, String...)
 	 */
 	public AuditApplicationEvent(String principal, String type, String... data) {
@@ -53,6 +59,10 @@ public class AuditApplicationEvent extends ApplicationEvent {
 	/**
 	 * Create a new {@link AuditApplicationEvent} that wraps a newly created
 	 * {@link AuditEvent}.
+	 * @param timestamp the time stamp
+	 * @param principal the principal
+	 * @param type the event type
+	 * @param data the event data
 	 * @see AuditEvent#AuditEvent(Date, String, String, Map)
 	 */
 	public AuditApplicationEvent(Date timestamp, String principal, String type,

spring-boot-actuator/src/main/java/org/springframework/boot/actuate/autoconfigure/ManagementServerProperties.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2014 the original author or authors.
+ * Copyright 2012-2015 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.
@@ -79,6 +79,7 @@ public class ManagementServerProperties implements SecurityPrerequisite {
 	/**
 	 * Returns the management port or {@code null} if the
 	 * {@link ServerProperties#getPort() server port} should be used.
+	 * @return the port
 	 * @see #setPort(Integer)
 	 */
 	public Integer getPort() {
@@ -88,6 +89,7 @@ public class ManagementServerProperties implements SecurityPrerequisite {
 	/**
 	 * Sets the port of the management server, use {@code null} if the
 	 * {@link ServerProperties#getPort() server port} should be used. To disable use 0.
+	 * @param port the port
 	 */
 	public void setPort(Integer port) {
 		this.port = port;

spring-boot-actuator/src/main/java/org/springframework/boot/actuate/autoconfigure/MetricRepositoryAutoConfiguration.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2014 the original author or authors.
+ * Copyright 2012-2015 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.
@@ -53,7 +53,7 @@ import com.codahale.metrics.MetricRegistry;
 /**
  * {@link EnableAutoConfiguration Auto-configuration} for metrics services. Creates
  * user-facing {@link GaugeService} and {@link CounterService} instances, and also back
- * end repositories to catch the data pumped into them. </p>
+ * end repositories to catch the data pumped into them.
  * <p>
  * An {@link InMemoryMetricRepository} is always created unless another
  * {@link MetricRepository} is already provided by the user. In general, even if metric
@@ -61,27 +61,23 @@ import com.codahale.metrics.MetricRegistry;
  * repository to buffer metric updates locally. The values can be exported (e.g. on a
  * periodic basis) using an {@link Exporter}, most implementations of which have
  * optimizations for sending data to remote repositories.
- * </p>
  * <p>
  * If Spring Messaging is on the classpath a {@link MessageChannel} called
  * "metricsChannel" is also created (unless one already exists) and all metric update
  * events are published additionally as messages on that channel. Additional analysis or
  * actions can be taken by clients subscribing to that channel.
- * </p>
  * <p>
  * In addition if Codahale's metrics library is on the classpath a {@link MetricRegistry}
  * will be created and wired up to the counter and gauge services in addition to the basic
  * repository. Users can create Codahale metrics by prefixing their metric names with the
  * appropriate type (e.g. "histogram.*", "meter.*") and sending them to the standard
  * <code>GaugeService</code> or <code>CounterService</code>.
- * </p>
  * <p>
  * By default all metric updates go to all {@link MetricWriter} instances in the
  * application context. To change this behaviour define your own metric writer bean called
  * "primaryMetricWriter", mark it <code>@Primary</code>, and this one will receive all
  * updates from the default counter and gauge services. Alternatively you can provide your
  * own counter and gauge services and wire them to whichever writer you choose.
- * </p>
  *
  * @see GaugeService
  * @see CounterService

spring-boot-actuator/src/main/java/org/springframework/boot/actuate/autoconfigure/ShellProperties.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2013-2014 the original author or authors.
+ * Copyright 2013-2015 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.
@@ -153,6 +153,7 @@ public class ShellProperties {
 	/**
 	 * Return a properties file configured from these settings that can be applied to a
 	 * CRaSH shell instance.
+	 * @return the CRaSH properties
 	 */
 	public Properties asCrshShellConfig() {
 		Properties properties = new Properties();
@@ -185,6 +186,7 @@ public class ShellProperties {
 
 	/**
 	 * Basic validation of applied CRaSH shell configuration.
+	 * @param properties the properties to validate
 	 */
 	protected void validateCrshShellConfig(Properties properties) {
 		String finalAuth = properties.getProperty("crash.auth");
@@ -205,6 +207,7 @@ public class ShellProperties {
 
 		/**
 		 * Apply the properties to a CRaSH configuration.
+		 * @param config the CRaSH configuration properties
 		 */
 		protected abstract void applyToCrshShellConfig(Properties config);
 

spring-boot-actuator/src/main/java/org/springframework/boot/actuate/endpoint/AbstractEndpoint.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2014 the original author or authors.
+ * Copyright 2012-2015 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.
@@ -25,6 +25,7 @@ import org.springframework.core.env.Environment;
 /**
  * Abstract base for {@link Endpoint} implementations.
  *
+ * @param <T> the endpoint data type
  * @author Phillip Webb
  * @author Christian Dupuis
  */

spring-boot-actuator/src/main/java/org/springframework/boot/actuate/endpoint/ConfigurationPropertiesReportEndpoint.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2013-2014 the original author or authors.
+ * Copyright 2013-2015 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.
@@ -102,7 +102,6 @@ public class ConfigurationPropertiesReportEndpoint extends
 
 	/**
 	 * Location path for JSON metadata about config properties.
-	 *
 	 * @param metadataLocations the metadataLocations to set
 	 */
 	public void setMetadataLocations(String metadataLocations) {
@@ -117,6 +116,8 @@ public class ConfigurationPropertiesReportEndpoint extends
 	/**
 	 * Extract beans annotated {@link ConfigurationProperties} and serialize into
 	 * {@link Map}.
+	 * @param context the application context
+	 * @return the beans
 	 */
 	protected Map<String, Object> extract(ApplicationContext context) {
 		// Serialize beans into map structure and sanitize values
@@ -191,6 +192,7 @@ public class ConfigurationPropertiesReportEndpoint extends
 	/**
 	 * Configure Jackson's {@link ObjectMapper} to be used to serialize the
 	 * {@link ConfigurationProperties} objects into a {@link Map} structure.
+	 * @param mapper the object mapper
 	 */
 	protected void configureObjectMapper(ObjectMapper mapper) {
 		mapper.configure(SerializationFeature.FAIL_ON_EMPTY_BEANS, false);

spring-boot-actuator/src/main/java/org/springframework/boot/actuate/endpoint/Endpoint.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2013 the original author or authors.
+ * Copyright 2012-2015 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.
@@ -21,6 +21,7 @@ package org.springframework.boot.actuate.endpoint;
  * exposed via Spring MVC but could also be exposed using some other technique. Consider
  * extending {@link AbstractEndpoint} if you are developing your own endpoint.
  *
+ * @param <T> the endpoint data type
  * @author Phillip Webb
  * @author Dave Syer
  * @author Christian Dupuis
@@ -31,17 +32,20 @@ public interface Endpoint<T> {
 	/**
 	 * The logical ID of the endpoint. Must only contain simple letters, numbers and '_'
 	 * characters (ie a {@literal "\w"} regex).
+	 * @return the endpoint ID
 	 */
 	String getId();
 
 	/**
 	 * Return if the endpoint is enabled.
+	 * @return if the endpoint is enabled
 	 */
 	boolean isEnabled();
 
 	/**
 	 * Return if the endpoint is sensitive, i.e. may return data that the average user
 	 * should not see. Mappings can use this as a security hint.
+	 * @return if the endpoint is sensitive
 	 */
 	boolean isSensitive();
 

spring-boot-actuator/src/main/java/org/springframework/boot/actuate/endpoint/HealthEndpoint.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2014 the original author or authors.
+ * Copyright 2012-2015 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.
@@ -44,6 +44,8 @@ public class HealthEndpoint extends AbstractEndpoint<Health> {
 
 	/**
 	 * Create a new {@link HealthIndicator} instance.
+	 * @param healthAggregator the health aggregator
+	 * @param healthIndicators the health indicators
 	 */
 	public HealthEndpoint(HealthAggregator healthAggregator,
 			Map<String, HealthIndicator> healthIndicators) {

spring-boot-actuator/src/main/java/org/springframework/boot/actuate/endpoint/SystemPublicMetrics.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2014 the original author or authors.
+ * Copyright 2012-2015 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.
@@ -64,6 +64,7 @@ public class SystemPublicMetrics implements PublicMetrics, Ordered {
 
 	/**
 	 * Add basic system metrics.
+	 * @param result the result
 	 */
 	protected void addBasicMetrics(Collection<Metric<?>> result) {
 		result.add(new Metric<Long>("mem", Runtime.getRuntime().totalMemory() / 1024));
@@ -81,6 +82,7 @@ public class SystemPublicMetrics implements PublicMetrics, Ordered {
 
 	/**
 	 * Add JVM heap metrics.
+	 * @param result the result
 	 */
 	protected void addHeapMetrics(Collection<Metric<?>> result) {
 		MemoryUsage memoryUsage = ManagementFactory.getMemoryMXBean()
@@ -93,6 +95,7 @@ public class SystemPublicMetrics implements PublicMetrics, Ordered {
 
 	/**
 	 * Add thread metrics.
+	 * @param result the result
 	 */
 	protected void addThreadMetrics(Collection<Metric<?>> result) {
 		ThreadMXBean threadMxBean = ManagementFactory.getThreadMXBean();
@@ -105,6 +108,7 @@ public class SystemPublicMetrics implements PublicMetrics, Ordered {
 
 	/**
 	 * Add class loading metrics.
+	 * @param result the result
 	 */
 	protected void addClassLoadingMetrics(Collection<Metric<?>> result) {
 		ClassLoadingMXBean classLoadingMxBean = ManagementFactory.getClassLoadingMXBean();
@@ -118,6 +122,7 @@ public class SystemPublicMetrics implements PublicMetrics, Ordered {
 
 	/**
 	 * Add garbage collection metrics.
+	 * @param result the result
 	 */
 	protected void addGarbageCollectionMetrics(Collection<Metric<?>> result) {
 		List<GarbageCollectorMXBean> garbageCollectorMxBeans = ManagementFactory

spring-boot-actuator/src/main/java/org/springframework/boot/actuate/endpoint/mvc/EndpointHandlerMapping.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2014 the original author or authors.
+ * Copyright 2012-2015 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.
@@ -60,7 +60,7 @@ public class EndpointHandlerMapping extends RequestMappingHandlerMapping impleme
 	/**
 	 * Create a new {@link EndpointHandlerMapping} instance. All {@link Endpoint}s will be
 	 * detected from the {@link ApplicationContext}.
-	 * @param endpoints
+	 * @param endpoints the endpoints
 	 */
 	public EndpointHandlerMapping(Collection<? extends MvcEndpoint> endpoints) {
 		this.endpoints = new HashSet<MvcEndpoint>(endpoints);
@@ -148,6 +148,7 @@ public class EndpointHandlerMapping extends RequestMappingHandlerMapping impleme
 	}
 
 	/**
+	 * @param endpoint the endpoint
 	 * @return the path used in mappings
 	 */
 	public String getPath(String endpoint) {
@@ -156,6 +157,7 @@ public class EndpointHandlerMapping extends RequestMappingHandlerMapping impleme
 
 	/**
 	 * Sets if this mapping is disabled.
+	 * @param disabled if the mapping is disabled
 	 */
 	public void setDisabled(boolean disabled) {
 		this.disabled = disabled;
@@ -163,6 +165,7 @@ public class EndpointHandlerMapping extends RequestMappingHandlerMapping impleme
 
 	/**
 	 * Returns if this mapping is disabled.
+	 * @return if the mapping is disabled
 	 */
 	public boolean isDisabled() {
 		return this.disabled;
@@ -170,6 +173,7 @@ public class EndpointHandlerMapping extends RequestMappingHandlerMapping impleme
 
 	/**
 	 * Return the endpoints
+	 * @return the endpoints
 	 */
 	public Set<? extends MvcEndpoint> getEndpoints() {
 		return new HashSet<MvcEndpoint>(this.endpoints);

spring-boot-actuator/src/main/java/org/springframework/boot/actuate/endpoint/mvc/MvcEndpoint.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2014 the original author or authors.
+ * Copyright 2012-2015 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.
@@ -31,11 +31,13 @@ public interface MvcEndpoint {
 
 	/**
 	 * Return the MVC path of the endpoint.
+	 * @return the endpoint path
 	 */
 	String getPath();
 
 	/**
 	 * Return if the endpoint exposes sensitive information.
+	 * @return if the endpoint is sensitive
 	 */
 	boolean isSensitive();
 
@@ -43,6 +45,7 @@ public interface MvcEndpoint {
 	 * Return the type of {@link Endpoint} exposed, or {@code null} if this
 	 * {@link MvcEndpoint} exposes information that cannot be represented as a traditional
 	 * {@link Endpoint}.
+	 * @return the endpoint type
 	 */
 	@SuppressWarnings("rawtypes")
 	Class<? extends Endpoint> getEndpointType();

spring-boot-actuator/src/main/java/org/springframework/boot/actuate/health/AbstractHealthAggregator.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2014 the original author or authors.
+ * Copyright 2012-2015 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.
@@ -44,7 +44,7 @@ public abstract class AbstractHealthAggregator implements HealthAggregator {
 	/**
 	 * Return the single 'aggregate' status that should be used from the specified
 	 * candidates.
-	 * @param candidates
+	 * @param candidates the candidates
 	 * @return a single status
 	 */
 	protected abstract Status aggregateStatus(List<Status> candidates);

spring-boot-actuator/src/main/java/org/springframework/boot/actuate/health/CompositeHealthIndicator.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2014 the original author or authors.
+ * Copyright 2012-2015 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.
@@ -37,6 +37,7 @@ public class CompositeHealthIndicator implements HealthIndicator {
 
 	/**
 	 * Create a new {@link CompositeHealthIndicator}.
+	 * @param healthAggregator the health aggregator
 	 */
 	public CompositeHealthIndicator(HealthAggregator healthAggregator) {
 		this(healthAggregator, new LinkedHashMap<String, HealthIndicator>());
@@ -44,6 +45,7 @@ public class CompositeHealthIndicator implements HealthIndicator {
 
 	/**
 	 * Create a new {@link CompositeHealthIndicator} from the specified indicators.
+	 * @param healthAggregator the health aggregator
 	 * @param indicators a map of {@link HealthIndicator}s with the key being used as an
 	 * indicator name.
 	 */

spring-boot-actuator/src/main/java/org/springframework/boot/actuate/health/DataSourceHealthIndicator.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2014 the original author or authors.
+ * Copyright 2012-2015 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.
@@ -153,6 +153,7 @@ public class DataSourceHealthIndicator extends AbstractHealthIndicator implement
 
 	/**
 	 * Set the {@link DataSource} to use.
+	 * @param dataSource the data source
 	 */
 	public void setDataSource(DataSource dataSource) {
 		this.dataSource = dataSource;
@@ -162,6 +163,7 @@ public class DataSourceHealthIndicator extends AbstractHealthIndicator implement
 	/**
 	 * Set a specific validation query to use to validate a connection. If none is set, a
 	 * default validation query is used.
+	 * @param query the query
 	 */
 	public void setQuery(String query) {
 		this.query = query;
@@ -169,6 +171,7 @@ public class DataSourceHealthIndicator extends AbstractHealthIndicator implement
 
 	/**
 	 * Return the validation query or {@code null}.
+	 * @return the query
 	 */
 	public String getQuery() {
 		return this.query;

spring-boot-actuator/src/main/java/org/springframework/boot/actuate/health/DiskSpaceHealthIndicator.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2014 the original author or authors.
+ * Copyright 2014-2015 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.
@@ -36,6 +36,7 @@ public class DiskSpaceHealthIndicator extends AbstractHealthIndicator {
 
 	/**
 	 * Create a new {@code DiskSpaceHealthIndicator}
+	 * @param properties the disk space properties
 	 */
 	@Autowired
 	public DiskSpaceHealthIndicator(DiskSpaceHealthIndicatorProperties properties) {

spring-boot-actuator/src/main/java/org/springframework/boot/actuate/health/Health.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2014 the original author or authors.
+ * Copyright 2012-2015 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.
@@ -150,6 +150,7 @@ public final class Health {
 
 	/**
 	 * Create a new {@link Builder} instance with a specific status code.
+	 * @param statusCode the status code
 	 * @return a new {@link Builder} instance
 	 */
 	public static Builder status(String statusCode) {
@@ -158,6 +159,7 @@ public final class Health {
 
 	/**
 	 * Create a new {@link Builder} instance with a specific {@link Status}.
+	 * @param status the status
 	 * @return a new {@link Builder} instance
 	 */
 	public static Builder status(Status status) {
@@ -270,6 +272,7 @@ public final class Health {
 
 		/**
 		 * Set status to given <code>statusCode</code>.
+		 * @param statusCode the status code
 		 * @return this {@link Builder} instance
 		 */
 		public Builder status(String statusCode) {
@@ -278,7 +281,7 @@ public final class Health {
 
 		/**
 		 * Set status to given {@link Status} instance
-		 * @param status
+		 * @param status the status
 		 * @return this {@link Builder} instance
 		 */
 		public Builder status(Status status) {

spring-boot-actuator/src/main/java/org/springframework/boot/actuate/health/HealthAggregator.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2014 the original author or authors.
+ * Copyright 2012-2015 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.
@@ -38,6 +38,8 @@ public interface HealthAggregator {
 
 	/**
 	 * Aggregate several given {@link Health} instances into one.
+	 * @param healths the health instances to aggregate
+	 * @return the aggregated health
 	 */
 	Health aggregate(Map<String, Health> healths);
 }

spring-boot-actuator/src/main/java/org/springframework/boot/actuate/metrics/Metric.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2013 the original author or authors.
+ * Copyright 2012-2015 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.
@@ -26,6 +26,7 @@ import org.springframework.util.ObjectUtils;
  * named numeric value with a timestamp). For example a metric might record the number of
  * active connections to a server, or the temperature of a meeting room.
  *
+ * @param <T> the value type
  * @author Dave Syer
  */
 public class Metric<T extends Number> {
@@ -60,6 +61,7 @@ public class Metric<T extends Number> {
 
 	/**
 	 * Returns the name of the metric.
+	 * @return the name
 	 */
 	public String getName() {
 		return this.name;
@@ -67,6 +69,7 @@ public class Metric<T extends Number> {
 
 	/**
 	 * Returns the value of the metric.
+	 * @return the value
 	 */
 	public T getValue() {
 		return this.value;
@@ -94,6 +97,7 @@ public class Metric<T extends Number> {
 
 	/**
 	 * Create a new {@link Metric} with a different value.
+	 * @param <S> the metric value type
 	 * @param value the value of the new metric
 	 * @return a new {@link Metric} instance
 	 */

spring-boot-actuator/src/main/java/org/springframework/boot/actuate/metrics/util/SimpleInMemoryRepository.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2013 the original author or authors.
+ * Copyright 2012-2015 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.
@@ -27,6 +27,7 @@ import org.springframework.util.ConcurrentReferenceHashMap;
 /**
  * Repository utility that stores stuff in memory with period-separated String keys.
  *
+ * @param <T> the type to store
  * @author Dave Syer
  */
 public class SimpleInMemoryRepository<T> {

spring-boot-actuator/src/main/java/org/springframework/boot/actuate/metrics/writer/Delta.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2013 the original author or authors.
+ * Copyright 2012-2015 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.
@@ -23,6 +23,7 @@ import org.springframework.boot.actuate.metrics.Metric;
 /**
  * A value object representing an increment in a metric value (usually a counter).
  *
+ * @param <T> the value type
  * @author Dave Syer
  */
 public class Delta<T extends Number> extends Metric<T> {

spring-boot-actuator/src/main/java/org/springframework/boot/actuate/metrics/writer/MetricWriter.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2013 the original author or authors.
+ * Copyright 2012-2015 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.
@@ -34,7 +34,7 @@ public interface MetricWriter {
 
 	/**
 	 * Set the value of a metric.
-	 * @param value
+	 * @param value the value
 	 */
 	void set(Metric<?> value);
 

spring-boot-actuator/src/main/java/org/springframework/boot/actuate/metrics/writer/PrefixMetricWriter.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2014 the original author or authors.
+ * Copyright 2012-2015 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.
@@ -39,6 +39,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 <code>group + "." + delta.name</code>.
+	 * @param group the name of the group
 	 * @param delta the amount to increment by
 	 */
 	void increment(String group, Delta<?> delta);

spring-boot-actuator/src/main/java/org/springframework/boot/actuate/system/ApplicationPidFileWriter.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2010-2014 the original author or authors.
+ * Copyright 2010-2015 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.
@@ -92,6 +92,7 @@ public class ApplicationPidFileWriter implements
 	 * Defaults to {@link ApplicationPreparedEvent}. NOTE: If you use the
 	 * {@link ApplicationPreparedEvent} to trigger the write, you will not be able to
 	 * specify the PID filename in the Spring {@link Environment}.
+	 * @param triggerEventType the event trigger type
 	 */
 	public void setTriggerEventType(
 			Class<? extends SpringApplicationEvent> triggerEventType) {

spring-boot-actuator/src/main/java/org/springframework/boot/actuate/trace/TraceRepository.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2013 the original author or authors.
+ * Copyright 2012-2015 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.
@@ -28,6 +28,7 @@ public interface TraceRepository {
 
 	/**
 	 * Find all {@link Trace} objects contained in the repository.
+	 * @return the results
 	 */
 	List<Trace> findAll();
 

spring-boot-actuator/src/main/java/org/springframework/boot/actuate/trace/WebRequestTraceFilter.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2014 the original author or authors.
+ * Copyright 2012-2015 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.
@@ -57,7 +57,8 @@ public class WebRequestTraceFilter extends OncePerRequestFilter implements Order
 	private ErrorAttributes errorAttributes;
 
 	/**
-	 * @param traceRepository
+	 * Create a new {@link WebRequestTraceFilter} instance.
+	 * @param traceRepository the trace repository
 	 */
 	public WebRequestTraceFilter(TraceRepository traceRepository) {
 		this.traceRepository = traceRepository;
@@ -66,6 +67,7 @@ public class WebRequestTraceFilter extends OncePerRequestFilter implements Order
 	/**
 	 * Debugging feature. If enabled, and trace logging is enabled then web request
 	 * headers will be logged.
+	 * @param dumpRequests if requests should be logged
 	 */
 	public void setDumpRequests(boolean dumpRequests) {
 		this.dumpRequests = dumpRequests;

spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/AutoConfigureAfter.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2013 the original author or authors.
+ * Copyright 2012-2015 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.
@@ -33,6 +33,7 @@ public @interface AutoConfigureAfter {
 
 	/**
 	 * The auto-configure classes that should have already been applied.
+	 * @return the classes
 	 */
 	Class<?>[] value();
 

spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/AutoConfigureBefore.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2013 the original author or authors.
+ * Copyright 2012-2015 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.
@@ -33,6 +33,7 @@ public @interface AutoConfigureBefore {
 
 	/**
 	 * The auto-configure classes that should have not yet been applied.
+	 * @return the classes
 	 */
 	Class<?>[] value();
 

spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/EnableAutoConfiguration.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2014 the original author or authors.
+ * Copyright 2012-2015 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.
@@ -74,6 +74,7 @@ public @interface EnableAutoConfiguration {
 
 	/**
 	 * Exclude specific auto-configuration classes such that they will never be applied.
+	 * @return the classes to exclude
 	 */
 	Class<?>[] exclude() default {};
 

spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/SpringBootApplication.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2014 the original author or authors.
+ * Copyright 2012-2015 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.
@@ -48,6 +48,7 @@ public @interface SpringBootApplication {
 
 	/**
 	 * Exclude specific auto-configuration classes such that they will never be applied.
+	 * @return the classes to exclude
 	 */
 	Class<?>[] exclude() default {};
 

spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/condition/AnyNestedCondition.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2014 the original author or authors.
+ * Copyright 2012-2015 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.
@@ -46,11 +46,11 @@ import org.springframework.util.StringUtils;
  * <pre class="code">
  * static class OnJndiOrProperty extends AnyNestedCondition {
  *
- *    &#064ConditionalOnJndi()
+ *    &#064;ConditionalOnJndi()
  *    static class OnJndi {
  *    }
 
- *    &#064ConditionalOnProperty("something")
+ *    &#064;ConditionalOnProperty("something")
  *    static class OnProperty {
  *    }
  *

spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/condition/BeanTypeRegistry.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2014 the original author or authors.
+ * Copyright 2012-2015 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.
@@ -291,6 +291,8 @@ abstract class BeanTypeRegistry {
 
 		/**
 		 * Returns the {@link OptimizedBeanTypeRegistry} for the given bean factory.
+		 * @param factory the source {@link BeanFactory}
+		 * @return the {@link OptimizedBeanTypeRegistry}
 		 */
 		public static OptimizedBeanTypeRegistry getFromFactory(
 				DefaultListableBeanFactory factory) {

spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/condition/ConditionEvaluationReport.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2013 the original author or authors.
+ * Copyright 2012-2015 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.
@@ -71,6 +71,7 @@ public class ConditionEvaluationReport {
 
 	/**
 	 * Returns condition outcomes from this report, grouped by the source.
+	 * @return the condition outcomes
 	 */
 	public Map<String, ConditionAndOutcomes> getConditionAndOutcomesBySource() {
 		return Collections.unmodifiableMap(this.outcomes);
@@ -127,6 +128,7 @@ public class ConditionEvaluationReport {
 
 		/**
 		 * Return {@code true} if all outcomes match.
+		 * @return {@code true} if a full match
 		 */
 		public boolean isFullMatch() {
 			for (ConditionAndOutcome conditionAndOutcomes : this) {

spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/condition/ConditionOutcome.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2013 the original author or authors.
+ * Copyright 2012-2015 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.
@@ -36,6 +36,7 @@ public class ConditionOutcome {
 
 	/**
 	 * Create a new {@link ConditionOutcome} instance for a 'match'.
+	 * @return the {@link ConditionOutcome}
 	 */
 	public static ConditionOutcome match() {
 		return match(null);
@@ -44,6 +45,7 @@ public class ConditionOutcome {
 	/**
 	 * Create a new {@link ConditionOutcome} instance for 'match'.
 	 * @param message the message
+	 * @return the {@link ConditionOutcome}
 	 */
 	public static ConditionOutcome match(String message) {
 		return new ConditionOutcome(true, message);
@@ -52,6 +54,7 @@ public class ConditionOutcome {
 	/**
 	 * Create a new {@link ConditionOutcome} instance for 'no match'.
 	 * @param message the message
+	 * @return the {@link ConditionOutcome}
 	 */
 	public static ConditionOutcome noMatch(String message) {
 		return new ConditionOutcome(false, message);
@@ -59,6 +62,7 @@ public class ConditionOutcome {
 
 	/**
 	 * Return {@code true} if the outcome was a match.
+	 * @return {@code true} if the outcome matches
 	 */
 	public boolean isMatch() {
 		return this.match;
@@ -66,6 +70,7 @@ public class ConditionOutcome {
 
 	/**
 	 * Return an outcome message or {@code null}.
+	 * @return the message or {@code null}
 	 */
 	public String getMessage() {
 		return this.message;

spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/condition/ConditionalOnBean.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2013 the original author or authors.
+ * Copyright 2012-2015 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.
@@ -70,6 +70,7 @@ public @interface ConditionalOnBean {
 	/**
 	 * Strategy to decide if the application context hierarchy (parent contexts) should be
 	 * considered.
+	 * @return the search strategy
 	 */
 	SearchStrategy search() default SearchStrategy.ALL;
 

spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/condition/ConditionalOnExpression.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2013 the original author or authors.
+ * Copyright 2012-2015 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.
@@ -37,6 +37,7 @@ public @interface ConditionalOnExpression {
 	/**
 	 * The SpEL expression to evaluate. Expression should return {@code true} if the
 	 * condition passes or {@code false} if it fails.
+	 * @return the SpEL expression
 	 */
 	String value() default "true";
 

spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/condition/ConditionalOnJava.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2014 the original author or authors.
+ * Copyright 2012-2015 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.
@@ -43,12 +43,14 @@ public @interface ConditionalOnJava {
 	 * Configures whether the value configured in {@link #value()} shall be considered the
 	 * upper exclusive or lower inclusive boundary. Defaults to
 	 * {@link Range#EQUAL_OR_NEWER}.
+	 * @return the range
 	 */
 	Range range() default Range.EQUAL_OR_NEWER;
 
 	/**
 	 * The {@link JavaVersion} to check for. Use {@link #range()} to specify whether the
 	 * configured value is an upper-exclusive or lower-inclusive boundary.
+	 * @return the java version
 	 */
 	JavaVersion value();
 
@@ -128,6 +130,7 @@ public @interface ConditionalOnJava {
 
 		/**
 		 * Returns the {@link JavaVersion} of the current runtime.
+		 * @return the {@link JavaVersion}
 		 */
 		public static JavaVersion getJavaVersion() {
 			int version = JdkVersion.getMajorJavaVersion();

spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/condition/ConditionalOnJndi.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2014 the original author or authors.
+ * Copyright 2012-2015 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.
@@ -42,6 +42,7 @@ public @interface ConditionalOnJndi {
 	/**
 	 * JNDI Locations, one of which must exist. If no locations are specific the condition
 	 * matches solely based on the presence of an {@link InitialContext}.
+	 * @return the JNDI locations
 	 */
 	String[] value() default {};
 

spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/condition/ConditionalOnMissingBean.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2013 the original author or authors.
+ * Copyright 2012-2015 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.
@@ -71,6 +71,7 @@ public @interface ConditionalOnMissingBean {
 	/**
 	 * Strategy to decide if the application context hierarchy (parent contexts) should be
 	 * considered.
+	 * @return the search strategy
 	 */
 	SearchStrategy search() default SearchStrategy.ALL;
 

spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/condition/ConditionalOnProperty.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2014 the original author or authors.
+ * Copyright 2012-2015 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,8 +35,7 @@ import org.springframework.core.env.Environment;
  * should have. The table below shows when a condition matches according to the property
  * value and the {@link #havingValue()} attribute:
  *
- * <p>
- * <table border="1">
+ * <table summary="having values" border="1">
  * <tr>
  * <th>Property Value</th>
  * <th>{@code havingValue=""}</th>
@@ -84,12 +83,14 @@ public @interface ConditionalOnProperty {
 
 	/**
 	 * Alias for {@link #name()}.
+	 * @return the names
 	 */
 	String[] value() default {};
 
 	/**
 	 * A prefix that should be applied to each property. The prefix automatically ends
 	 * with a dot if not specified.
+	 * @return the prefix
 	 */
 	String prefix() default "";
 
@@ -101,23 +102,27 @@ public @interface ConditionalOnProperty {
 	 * <p>
 	 * Use the dashed notation to specify each property, that is all lower case with a "-"
 	 * to separate words (e.g. {@code my-long-property}).
+	 * @return the names
 	 */
 	String[] name() default {};
 
 	/**
 	 * The string representation of the expected value for the properties. If not
-	 * specified, the property must <strong>not</strong> be equals to {@code false}
+	 * specified, the property must <strong>not</strong> be equals to {@code false}.
+	 * @return the expected value
 	 */
 	String havingValue() default "";
 
 	/**
 	 * Specify if the condition should match if the property is not set. Defaults to
-	 * {@code false}
+	 * {@code false}.
+	 * @return if should match if the property is missing
 	 */
 	boolean matchIfMissing() default false;
 
 	/**
 	 * If relaxed names should be checked. Defaults to {@code true}.
+	 * @return if relaxed names are used
 	 */
 	boolean relaxedNames() default true;
 

spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/condition/SpringBootCondition.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2014 the original author or authors.
+ * Copyright 2012-2015 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.
@@ -112,6 +112,9 @@ public abstract class SpringBootCondition implements Condition {
 
 	/**
 	 * Determine the outcome of the match along with suitable log output.
+	 * @param context the condition context
+	 * @param metadata the annotation metadata
+	 * @return the condition outcome
 	 */
 	public abstract ConditionOutcome getMatchOutcome(ConditionContext context,
 			AnnotatedTypeMetadata metadata);

spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/data/AbstractRepositoryConfigurationSourceSupport.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2014 the original author or authors.
+ * Copyright 2012-2015 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.
@@ -79,16 +79,19 @@ public abstract class AbstractRepositoryConfigurationSourceSupport implements
 
 	/**
 	 * The Spring Data annotation used to enable the particular repository support.
+	 * @return the annotation class
 	 */
 	protected abstract Class<? extends Annotation> getAnnotation();
 
 	/**
 	 * The configuration class that will be used by Spring Boot as a template.
+	 * @return the configuration class
 	 */
 	protected abstract Class<?> getConfiguration();
 
 	/**
 	 * The {@link RepositoryConfigurationExtension} for the particular repository support.
+	 * @return the repository configuration extension
 	 */
 	protected abstract RepositoryConfigurationExtension getRepositoryConfigurationExtension();
 

spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/jdbc/DataSourceAutoConfiguration.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2014 the original author or authors.
+ * Copyright 2012-2015 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.
@@ -71,6 +71,7 @@ public class DataSourceAutoConfiguration {
 	/**
 	 * Determines if the {@code dataSource} being used by Spring was created from
 	 * {@link EmbeddedDataSourceConfiguration}.
+	 * @param beanFactory the bean factory
 	 * @return true if the data source was auto-configured.
 	 */
 	public static boolean containsAutoConfiguredDataSource(

spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/jdbc/EmbeddedDatabaseConnection.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2014 the original author or authors.
+ * Copyright 2012-2015 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.
@@ -73,6 +73,7 @@ public enum EmbeddedDatabaseConnection {
 
 	/**
 	 * Returns the driver class name.
+	 * @return the driver class name
 	 */
 	public String getDriverClassName() {
 		return this.driverClass;
@@ -80,6 +81,7 @@ public enum EmbeddedDatabaseConnection {
 
 	/**
 	 * Returns the {@link EmbeddedDatabaseType} for the connection.
+	 * @return the database type
 	 */
 	public EmbeddedDatabaseType getType() {
 		return this.type;
@@ -87,6 +89,7 @@ public enum EmbeddedDatabaseConnection {
 
 	/**
 	 * Returns the URL for the connection.
+	 * @return the connection URL
 	 */
 	public String getUrl() {
 		return this.url;

spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/jdbc/metadata/AbstractDataSourcePoolMetadata.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2014 the original author or authors.
+ * Copyright 2012-2015 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.
@@ -21,6 +21,7 @@ import javax.sql.DataSource;
 /**
  * A base {@link DataSourcePoolMetadata} implementation.
  *
+ * @param <T> The datasource type
  * @author Stephane Nicoll
  * @since 1.2.0
  */
@@ -31,6 +32,7 @@ public abstract class AbstractDataSourcePoolMetadata<T extends DataSource> imple
 
 	/**
 	 * Create an instance with the data source to use.
+	 * @param dataSource the data source
 	 */
 	protected AbstractDataSourcePoolMetadata(T dataSource) {
 		this.dataSource = dataSource;

spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/jdbc/metadata/DataSourcePoolMetadata.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2014 the original author or authors.
+ * Copyright 2012-2015 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.
@@ -37,12 +37,14 @@ public interface DataSourcePoolMetadata {
 	 * </ul>
 	 * This may also return {@code null} if the data source does not provide the necessary
 	 * information to compute the poll usage.
+	 * @return the usage value or {@code null}
 	 */
 	Float getUsage();
 
 	/**
 	 * Return the current number of active connections that have been allocated from the
 	 * data source or {@code null} if that information is not available.
+	 * @return the number of active connections or {@code null}
 	 */
 	Integer getActive();
 
@@ -50,18 +52,21 @@ public interface DataSourcePoolMetadata {
 	 * Return the maximum number of active connections that can be allocated at the same
 	 * time or {@code -1} if there is no limit. Can also return {@code null} if that
 	 * information is not available.
+	 * @return the maximum number of active connections or {@code null}
 	 */
 	Integer getMax();
 
 	/**
 	 * Return the minimum number of idle connections in the pool or {@code null} if that
 	 * information is not available.
+	 * @return the minimum number of active connections or {@code null}
 	 */
 	Integer getMin();
 
 	/**
 	 * Return the query to use to validate that a connection is valid or {@code null} if
 	 * that information is not available.
+	 * @return the validation query or {@code null}
 	 */
 	String getValidationQuery();
 

spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/jdbc/metadata/DataSourcePoolMetadataProvider.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2014 the original author or authors.
+ * Copyright 2012-2015 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.
@@ -29,6 +29,8 @@ public interface DataSourcePoolMetadataProvider {
 	/**
 	 * Return the {@link DataSourcePoolMetadata} instance able to manage the specified
 	 * {@link DataSource} or {@code null} if the given data source could not be handled.
+	 * @param dataSource the data source
+	 * @return the data source pool metadata
 	 */
 	DataSourcePoolMetadata getDataSourcePoolMetadata(DataSource dataSource);
 

spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/jdbc/metadata/DataSourcePoolMetadataProviders.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2014 the original author or authors.
+ * Copyright 2012-2015 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.
@@ -36,6 +36,7 @@ public class DataSourcePoolMetadataProviders implements DataSourcePoolMetadataPr
 	/**
 	 * Create a {@link DataSourcePoolMetadataProviders} instance with an initial
 	 * collection of delegates to use.
+	 * @param providers the data source pool metdata providers
 	 */
 	public DataSourcePoolMetadataProviders(
 			Collection<? extends DataSourcePoolMetadataProvider> providers) {

spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/jdbc/metadata/TomcatDataSourcePoolMetadata.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2014 the original author or authors.
+ * Copyright 2012-2015 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 @@ import org.apache.tomcat.jdbc.pool.ConnectionPool;
 import org.apache.tomcat.jdbc.pool.DataSource;
 
 /**
- * {@link DataSourcePoolMetadata} for a Tomcat {@link DataSource}.
+ * {@link DataSourcePoolMetadata} for a Tomcat DataSource.
  *
  * @author Stephane Nicoll
  */

spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/jms/hornetq/HornetQProperties.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2014 the original author or authors.
+ * Copyright 2012-2015 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.
@@ -187,6 +187,7 @@ public class HornetQProperties {
 		/**
 		 * Creates the minimal transport parameters for an embedded transport
 		 * configuration.
+		 * @return the transport parameters
 		 * @see TransportConstants#SERVER_ID_PROP_NAME
 		 */
 		public Map<String, Object> generateTransportParameters() {

spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/orm/jpa/EntityManagerFactoryBuilder.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2014 the original author or authors.
+ * Copyright 2012-2015 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.
@@ -71,6 +71,7 @@ public class EntityManagerFactoryBuilder {
 
 	/**
 	 * An optional callback for new entity manager factory beans.
+	 * @param callback the entity manager factory bean callback
 	 */
 	public void setCallback(EntityManagerFactoryBeanCallback callback) {
 		this.callback = callback;

spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/orm/jpa/JpaBaseConfiguration.java

@@ -147,6 +147,7 @@ public abstract class JpaBaseConfiguration implements BeanFactoryAware {
 
 	/**
 	 * Returns if a JTA {@link PlatformTransactionManager} is being used.
+	 * @return if a JTA transaction manager is being used
 	 */
 	protected final boolean isJta() {
 		return (this.jtaTransactionManager != null);

spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/template/AbstractViewResolverProperties.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2014 the original author or authors.
+ * Copyright 2012-2015 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.
@@ -103,6 +103,7 @@ public abstract class AbstractViewResolverProperties {
 
 	/**
 	 * @deprecated since 1.2.0 in favor of {@link #getCharset()}
+	 * @return the charset
 	 */
 	@Deprecated
 	public String getCharSet() {
@@ -111,6 +112,7 @@ public abstract class AbstractViewResolverProperties {
 
 	/**
 	 * @deprecated since 1.2.0 in favor of {@link #setCharset(String)}
+	 * @param charSet the charset
 	 */
 	@Deprecated
 	public void setCharSet(String charSet) {

spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/template/TemplateAvailabilityProvider.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2014 the original author or authors.
+ * Copyright 2012-2015 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.
@@ -34,6 +34,7 @@ public interface TemplateAvailabilityProvider {
 	 * @param environment the environment
 	 * @param classLoader the class loader
 	 * @param resourceLoader the resource loader
+	 * @return if the template is available
 	 */
 	boolean isTemplateAvailable(String view, Environment environment,
 			ClassLoader classLoader, ResourceLoader resourceLoader);

spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/web/ErrorController.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2014 the original author or authors.
+ * Copyright 2012-2015 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.
@@ -28,6 +28,7 @@ public interface ErrorController {
 
 	/**
 	 * Returns the path of the error page.
+	 * @return the error path
 	 */
 	public String getErrorPath();
 

spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/web/MultipartAutoConfiguration.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2013 the original author or authors.
+ * Copyright 2012-2015 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.
@@ -38,7 +38,7 @@ import org.springframework.web.servlet.DispatcherServlet;
  * {@link javax.servlet.MultipartConfigElement multipartConfigElement} if none is
  * otherwise defined. The {@link EmbeddedWebApplicationContext} will associate the
  * {@link MultipartConfigElement} bean to any {@link Servlet} beans.
- * <p/>
+ * <p>
  * The {@link javax.servlet.MultipartConfigElement} is a Servlet API that's used to
  * configure how the container handles file uploads. By default
  *

spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/websocket/WebSocketContainerCustomizer.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2014 the original author or authors.
+ * Copyright 2012-2015 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.
@@ -29,6 +29,7 @@ import org.springframework.core.ResolvableType;
  * {@link EmbeddedServletContainerCustomizer} to configure websockets for a given
  * {@link EmbeddedServletContainerFactory}.
  *
+ * @param <T> the embded servlet container factory
  * @author Dave Syer
  * @author Phillip Webb
  * @author Andy Wilkinson

spring-boot-docs/pom.xml

@@ -39,6 +39,287 @@
 			<groupId>org.springframework.boot</groupId>
 			<artifactId>spring-boot-loader-tools</artifactId>
 		</dependency>
+		<!-- Optional deps required when generating Javadoc with Java 8 -->
+		<dependency>
+			<groupId>ch.qos.logback</groupId>
+			<artifactId>logback-classic</artifactId>
+			<optional>true</optional>
+		</dependency>
+		<dependency>
+			<groupId>com.atomikos</groupId>
+			<artifactId>transactions-jms</artifactId>
+			<optional>true</optional>
+		</dependency>
+		<dependency>
+			<groupId>com.atomikos</groupId>
+			<artifactId>transactions-jta</artifactId>
+			<optional>true</optional>
+		</dependency>
+		<dependency>
+			<groupId>com.atomikos</groupId>
+			<artifactId>transactions-jdbc</artifactId>
+			<optional>true</optional>
+		</dependency>
+		<dependency>
+			<groupId>com.fasterxml.jackson.core</groupId>
+			<artifactId>jackson-databind</artifactId>
+			<optional>true</optional>
+		</dependency>
+		<dependency>
+			<groupId>com.google.code.gson</groupId>
+			<artifactId>gson</artifactId>
+			<optional>true</optional>
+		</dependency>
+		<dependency>
+			<groupId>com.googlecode.json-simple</groupId>
+			<artifactId>json-simple</artifactId>
+			<optional>true</optional>
+		</dependency>
+		<dependency>
+			<groupId>com.samskivert</groupId>
+			<artifactId>jmustache</artifactId>
+			<optional>true</optional>
+		</dependency>
+		<dependency>
+			<groupId>io.dropwizard.metrics</groupId>
+			<artifactId>metrics-core</artifactId>
+			<optional>true</optional>
+		</dependency>
+		<dependency>
+			<groupId>io.undertow</groupId>
+			<artifactId>undertow-servlet</artifactId>
+			<optional>true</optional>
+		</dependency>
+		<dependency>
+			<groupId>javax.jms</groupId>
+			<artifactId>jms-api</artifactId>
+			<optional>true</optional>
+		</dependency>
+		<dependency>
+			<groupId>javax.servlet</groupId>
+			<artifactId>javax.servlet-api</artifactId>
+			<optional>true</optional>
+		</dependency>
+		<dependency>
+			<groupId>log4j</groupId>
+			<artifactId>log4j</artifactId>
+			<optional>true</optional>
+		</dependency>
+        <dependency>
+            <groupId>org.apache.logging.log4j</groupId>
+            <artifactId>log4j-api</artifactId>
+            <optional>true</optional>
+        </dependency>
+        <dependency>
+            <groupId>org.apache.logging.log4j</groupId>
+            <artifactId>log4j-core</artifactId>
+            <optional>true</optional>
+        </dependency>
+		<dependency>
+			<groupId>org.apache.httpcomponents</groupId>
+			<artifactId>httpclient</artifactId>
+			<optional>true</optional>
+		</dependency>
+		<dependency>
+			<groupId>org.apache.tomcat.embed</groupId>
+			<artifactId>tomcat-embed-core</artifactId>
+			<optional>true</optional>
+		</dependency>
+		<dependency>
+			<groupId>org.apache.tomcat.embed</groupId>
+			<artifactId>tomcat-embed-jasper</artifactId>
+			<optional>true</optional>
+		</dependency>
+		<dependency>
+			<groupId>org.apache.tomcat.embed</groupId>
+			<artifactId>tomcat-embed-logging-juli</artifactId>
+			<optional>true</optional>
+		</dependency>
+		<dependency>
+			<groupId>org.codehaus.btm</groupId>
+			<artifactId>btm</artifactId>
+			<optional>true</optional>
+		</dependency>
+		<dependency>
+			<groupId>org.codehaus.groovy</groupId>
+			<artifactId>groovy</artifactId>
+			<optional>true</optional>
+		</dependency>
+		<dependency>
+			<groupId>org.codehaus.groovy</groupId>
+			<artifactId>groovy-xml</artifactId>
+			<optional>true</optional>
+		</dependency>
+		<dependency>
+			<groupId>org.crashub</groupId>
+			<artifactId>crash.shell</artifactId>
+			<optional>true</optional>
+		</dependency>
+		<dependency>
+			<groupId>org.eclipse.jetty</groupId>
+			<artifactId>jetty-util</artifactId>
+			<optional>true</optional>
+		</dependency>
+		<dependency>
+			<groupId>org.eclipse.jetty</groupId>
+			<artifactId>jetty-servlets</artifactId>
+			<optional>true</optional>
+		</dependency>
+		<dependency>
+			<groupId>org.eclipse.jetty</groupId>
+			<artifactId>jetty-webapp</artifactId>
+			<optional>true</optional>
+		</dependency>
+		<dependency>
+			<groupId>org.flywaydb</groupId>
+			<artifactId>flyway-core</artifactId>
+			<optional>true</optional>
+		</dependency>
+		<dependency>
+			<groupId>org.hibernate</groupId>
+			<artifactId>hibernate-entitymanager</artifactId>
+			<optional>true</optional>
+		</dependency>
+		<dependency>
+			<groupId>org.hibernate</groupId>
+			<artifactId>hibernate-validator</artifactId>
+			<optional>true</optional>
+		</dependency>
+		<dependency>
+			<groupId>org.hornetq</groupId>
+			<artifactId>hornetq-jms-server</artifactId>
+			<optional>true</optional>
+		</dependency>
+		<dependency>
+			<groupId>org.jolokia</groupId>
+			<artifactId>jolokia-core</artifactId>
+			<optional>true</optional>
+		</dependency>
+		<dependency>
+			<groupId>org.liquibase</groupId>
+			<artifactId>liquibase-core</artifactId>
+			<optional>true</optional>
+		</dependency>
+		<dependency>
+			<groupId>org.slf4j</groupId>
+			<artifactId>slf4j-api</artifactId>
+			<optional>true</optional>
+		</dependency>
+		<dependency>
+			<groupId>org.slf4j</groupId>
+			<artifactId>jul-to-slf4j</artifactId>
+			<optional>true</optional>
+		</dependency>
+		<dependency>
+			<groupId>org.springframework</groupId>
+			<artifactId>spring-messaging</artifactId>
+			<optional>true</optional>
+		</dependency>
+		<dependency>
+			<groupId>org.springframework</groupId>
+			<artifactId>spring-orm</artifactId>
+			<optional>true</optional>
+		</dependency>
+		<dependency>
+			<groupId>org.springframework</groupId>
+			<artifactId>spring-test</artifactId>
+			<optional>true</optional>
+		</dependency>
+		<dependency>
+			<groupId>org.springframework</groupId>
+			<artifactId>spring-web</artifactId>
+			<optional>true</optional>
+		</dependency>
+		<dependency>
+			<groupId>org.springframework</groupId>
+			<artifactId>spring-webmvc</artifactId>
+			<optional>true</optional>
+		</dependency>
+		<dependency>
+			<groupId>org.springframework.amqp</groupId>
+			<artifactId>spring-rabbit</artifactId>
+			<optional>true</optional>
+		</dependency>
+		<dependency>
+			<groupId>org.springframework.batch</groupId>
+			<artifactId>spring-batch-core</artifactId>
+			<optional>true</optional>
+		</dependency>
+		<dependency>
+			<groupId>org.springframework.cloud</groupId>
+			<artifactId>spring-cloud-core</artifactId>
+			<optional>true</optional>
+		</dependency>
+		<dependency>
+			<groupId>org.springframework.cloud</groupId>
+			<artifactId>spring-cloud-spring-service-connector</artifactId>
+			<optional>true</optional>
+		</dependency>
+		<dependency>
+			<groupId>org.springframework.security</groupId>
+			<artifactId>spring-security-config</artifactId>
+			<optional>true</optional>
+		</dependency>
+		<dependency>
+			<groupId>org.springframework.data</groupId>
+			<artifactId>spring-data-elasticsearch</artifactId>
+			<optional>true</optional>
+		</dependency>
+		<dependency>
+			<groupId>org.springframework.data</groupId>
+			<artifactId>spring-data-jpa</artifactId>
+			<optional>true</optional>
+		</dependency>
+		<dependency>
+			<groupId>org.springframework.data</groupId>
+			<artifactId>spring-data-mongodb</artifactId>
+			<optional>true</optional>
+		</dependency>
+		<dependency>
+			<groupId>org.springframework.data</groupId>
+			<artifactId>spring-data-rest-core</artifactId>
+			<optional>true</optional>
+		</dependency>
+		<dependency>
+			<groupId>org.springframework.data</groupId>
+			<artifactId>spring-data-rest-webmvc</artifactId>
+			<optional>true</optional>
+		</dependency>
+		<dependency>
+			<groupId>org.springframework.data</groupId>
+			<artifactId>spring-data-solr</artifactId>
+			<optional>true</optional>
+		</dependency>
+		<dependency>
+			<groupId>org.springframework.hateoas</groupId>
+			<artifactId>spring-hateoas</artifactId>
+			<optional>true</optional>
+		</dependency>
+		<dependency>
+			<groupId>org.springframework.mobile</groupId>
+			<artifactId>spring-mobile-device</artifactId>
+			<optional>true</optional>
+		</dependency>
+		<dependency>
+			<groupId>org.springframework.security</groupId>
+			<artifactId>spring-security-web</artifactId>
+			<optional>true</optional>
+		</dependency>
+		<dependency>
+			<groupId>org.springframework.social</groupId>
+			<artifactId>spring-social-config</artifactId>
+			<optional>true</optional>
+		</dependency>
+		<dependency>
+			<groupId>org.thymeleaf</groupId>
+			<artifactId>thymeleaf-spring4</artifactId>
+			<optional>true</optional>
+		</dependency>
+		<dependency>
+			<groupId>org.yaml</groupId>
+			<artifactId>snakeyaml</artifactId>
+			<optional>true</optional>
+		</dependency>
 	</dependencies>
 	<profiles>
 		<profile>
@@ -63,8 +344,13 @@
 									<quiet>true</quiet>
 									<stylesheetfile>${basedir}/src/main/javadoc/spring-javadoc.css</stylesheetfile>
 									<links>
-										<link>http://docs.spring.io/spring-framework/docs/4.0.x/javadoc-api/</link>
 										<link>http://docs.oracle.com/javase/7/docs/api/</link>
+										<link>http://docs.oracle.com/javaee/7/api/</link>
+										<link>http://docs.spring.io/spring-framework/docs/${spring.version}/javadoc-api/</link>
+										<link>http://docs.spring.io/autorepo/docs/spring-security/${spring-security.version}/apidocs/</link>
+										<link>http://tomcat.apache.org/tomcat-8.0-doc/api/</link>
+										<link>http://download.eclipse.org/jetty/stable-9/apidocs/</link>
+										<link>http://www.thymeleaf.org/apidocs/thymeleaf/${thymeleaf.version}/</link>
 									</links>
 								</configuration>
 							</execution>

spring-boot-tools/spring-boot-gradle-plugin/src/main/groovy/org/springframework/boot/gradle/PluginFeatures.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2014 the original author or authors.
+ * Copyright 2012-2015 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.
@@ -16,11 +16,11 @@
 
 package org.springframework.boot.gradle;
 
-import org.gradle.api.Plugin;
 import org.gradle.api.Project;
 
 /**
- * A specific set of {@link Plugin} features applied via the {@link SpringBootPlugin}.
+ * A specific set of {@code org.gradle.api.Plugin} features applied via the
+ * {@code SpringBootPlugin}.
  *
  * @author Phillip Webb
  */

spring-boot-tools/spring-boot-maven-plugin/src/main/java/org/springframework/boot/maven/DependencyFilter.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2014 the original author or authors.
+ * Copyright 2014-2015 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.
  * You may obtain a copy of the License at
@@ -38,6 +38,7 @@ public abstract class DependencyFilter extends AbstractArtifactsFilter {
 	/**
 	 * Create a new instance with the list of {@link FilterableDependency} instance(s) to
 	 * use.
+	 * @param dependencies the source dependencies
 	 */
 	public DependencyFilter(List<? extends FilterableDependency> dependencies) {
 		this.filters = dependencies;
@@ -61,6 +62,9 @@ public abstract class DependencyFilter extends AbstractArtifactsFilter {
 	 * Check if the specified {@link org.apache.maven.artifact.Artifact} matches the
 	 * specified {@link org.springframework.boot.maven.FilterableDependency}. Returns
 	 * {@code true} if it should be excluded
+	 * @param artifact the Maven {@link Artifact}
+	 * @param dependency the {@link FilterableDependency}
+	 * @return {@code true} if the artifact matches the dependency
 	 */
 	protected final boolean equals(Artifact artifact, FilterableDependency dependency) {
 		if (!dependency.getGroupId().equals(artifact.getGroupId())) {

spring-boot-tools/spring-boot-maven-plugin/src/main/java/org/springframework/boot/maven/ExcludeFilter.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2014 the original author or authors.
+ * Copyright 2012-2015 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.
@@ -21,8 +21,7 @@ import java.util.List;
 import org.apache.maven.artifact.Artifact;
 
 /**
- * An {@ArtifactsFilter} that filters out any artifact matching an
- * {@link Exclude}.
+ * An {DependencyFilter} that filters out any artifact matching an {@link Exclude}.
  *
  * @author Stephane Nicoll
  * @author David Turanski

spring-boot-tools/spring-boot-maven-plugin/src/main/java/org/springframework/boot/maven/MatchingGroupIdFilter.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2014 the original author or authors.
+ * Copyright 2012-2015 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.
@@ -34,6 +34,7 @@ public class MatchingGroupIdFilter extends AbstractArtifactFeatureFilter {
 
 	/**
 	 * Create a new instance with the CSV groupId values that should be excluded.
+	 * @param exclude the group values to exclude
 	 */
 	public MatchingGroupIdFilter(String exclude) {
 		super("", exclude);

spring-boot/src/main/java/org/springframework/boot/json/JsonJsonParser.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2014 the original author or authors.
+ * Copyright 2012-2015 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.
@@ -25,7 +25,7 @@ import org.json.JSONArray;
 import org.json.JSONObject;
 
 /**
- * Thin wrapper to adapt {@link org.json.JSONObject} to a {@link JsonParser}.
+ * Thin wrapper to adapt {@code org.json.JSONObject} to a {@link JsonParser}.
  *
  * @author Dave Syer
  * @since 1.2.0