Polish Gradle plugin's javadoc

Author: wilkinsona

spring-boot-project/spring-boot-tools/spring-boot-gradle-plugin/src/main/java/org/springframework/boot/gradle/dsl/SpringBootExtension.java

@@ -44,7 +44,6 @@ public class SpringBootExtension {
 	/**
 	 * Creates a new {@code SpringBootPluginExtension} that is associated with the given
 	 * {@code project}.
-	 *
 	 * @param project the project
 	 */
 	public SpringBootExtension(Project project) {
@@ -53,7 +52,6 @@ public SpringBootExtension(Project project) {
 
 	/**
 	 * Returns the main class name of the application.
-	 *
 	 * @return the name of the application's main class
 	 */
 	public String getMainClassName() {
@@ -62,7 +60,6 @@ public String getMainClassName() {
 
 	/**
 	 * Sets the main class name of the application.
-	 *
 	 * @param mainClassName the name of the application's main class
 	 */
 	public void setMainClassName(String mainClassName) {
@@ -89,7 +86,6 @@ public void buildInfo() {
 	 * By default, the task's destination dir will be a directory named {@code META-INF}
 	 * beneath the main source set's resources output directory, and the task's project
 	 * artifact will be the base name of the {@code bootWar} or {@code bootJar} task.
-	 *
 	 * @param configurer the task configurer
 	 */
 	public void buildInfo(Action<BuildInfo> configurer) {

spring-boot-project/spring-boot-tools/spring-boot-gradle-plugin/src/main/java/org/springframework/boot/gradle/plugin/PluginApplicationAction.java

@@ -31,7 +31,6 @@ interface PluginApplicationAction extends Action<Project> {
 	/**
 	 * The class of the {@code Plugin} that, when applied, will trigger the execution of
 	 * this action. May return {@code null} if the plugin class is not on the classpath.
-	 *
 	 * @return the plugin class or {@code null}
 	 */
 	Class<? extends Plugin<? extends Project>> getPluginClass();

spring-boot-project/spring-boot-tools/spring-boot-gradle-plugin/src/main/java/org/springframework/boot/gradle/plugin/SpringBootPlugin.java

@@ -55,14 +55,12 @@ public class SpringBootPlugin implements Plugin<Project> {
 
 	/**
 	 * The name of the default {@link BootJar} task.
-	 *
 	 * @since 2.0.0
 	 */
 	public static final String BOOT_JAR_TASK_NAME = "bootJar";
 
 	/**
 	 * The name of the default {@link BootWar} task.
-	 *
 	 * @since 2.0.0
 	 */
 	public static final String BOOT_WAR_TASK_NAME = "bootWar";

spring-boot-project/spring-boot-tools/spring-boot-gradle-plugin/src/main/java/org/springframework/boot/gradle/tasks/application/CreateBootStartScripts.java

@@ -24,6 +24,7 @@
  * main class name} optional.
  *
  * @author Andy Wilkinson
+ * @since 2.0.0
  */
 public class CreateBootStartScripts extends CreateStartScripts {
 

spring-boot-project/spring-boot-tools/spring-boot-gradle-plugin/src/main/java/org/springframework/boot/gradle/tasks/buildinfo/BuildInfo.java

@@ -39,6 +39,7 @@
  * {@code Project}.
  *
  * @author Andy Wilkinson
+ * @since 2.0.0
  */
 public class BuildInfo extends ConventionTask {
 
@@ -73,7 +74,6 @@ public void generateBuildProperties() {
 	/**
 	 * Returns the directory to which the {@code build-info.properties} file will be
 	 * written. Defaults to the {@link Project#getBuildDir() Project's build directory}.
-	 *
 	 * @return the destination directory
 	 */
 	@OutputDirectory

spring-boot-project/spring-boot-tools/spring-boot-gradle-plugin/src/main/java/org/springframework/boot/gradle/tasks/buildinfo/BuildInfoProperties.java

@@ -27,6 +27,7 @@
  * The properties that are written into the {@code build-info.properties} file.
  *
  * @author Andy Wilkinson
+ * @since 2.0.0
  */
 @SuppressWarnings("serial")
 public class BuildInfoProperties implements Serializable {
@@ -53,7 +54,6 @@ public class BuildInfoProperties implements Serializable {
 	/**
 	 * Returns the value used for the {@code build.group} property. Defaults to the
 	 * {@link Project#getGroup() Project's group}.
-	 *
 	 * @return the group
 	 */
 	public String getGroup() {
@@ -65,7 +65,6 @@ public String getGroup() {
 
 	/**
 	 * Sets the value used for the {@code build.group} property.
-	 *
 	 * @param group the group name
 	 */
 	public void setGroup(String group) {
@@ -74,7 +73,6 @@ public void setGroup(String group) {
 
 	/**
 	 * Returns the value used for the {@code build.artifact} property.
-	 *
 	 * @return the artifact
 	 */
 	public String getArtifact() {
@@ -83,7 +81,6 @@ public String getArtifact() {
 
 	/**
 	 * Sets the value used for the {@code build.artifact} property.
-	 *
 	 * @param artifact the artifact
 	 */
 	public void setArtifact(String artifact) {
@@ -93,7 +90,6 @@ public void setArtifact(String artifact) {
 	/**
 	 * Returns the value used for the {@code build.version} property. Defaults to the
 	 * {@link Project#getVersion() Project's version}.
-	 *
 	 * @return the version
 	 */
 	public String getVersion() {
@@ -105,7 +101,6 @@ public String getVersion() {
 
 	/**
 	 * Sets the value used for the {@code build.version} property.
-	 *
 	 * @param version the version
 	 */
 	public void setVersion(String version) {
@@ -115,7 +110,6 @@ public void setVersion(String version) {
 	/**
 	 * Returns the value used for the {@code build.name} property. Defaults to the
 	 * {@link Project#getDisplayName() Project's display name}.
-	 *
 	 * @return the name
 	 */
 	public String getName() {
@@ -127,7 +121,6 @@ public String getName() {
 
 	/**
 	 * Sets the value used for the {@code build.name} property.
-	 *
 	 * @param name the name
 	 */
 	public void setName(String name) {
@@ -154,7 +147,6 @@ public void setTime(Instant time) {
 	/**
 	 * Returns the additional properties that will be included. When written, the name of
 	 * each additional property is prefixed with {@code build.}.
-	 *
 	 * @return the additional properties
 	 */
 	public Map<String, Object> getAdditional() {
@@ -164,7 +156,6 @@ public Map<String, Object> getAdditional() {
 	/**
 	 * Sets the additional properties that will be included. When written, the name of
 	 * each additional property is prefixed with {@code build.}.
-	 *
 	 * @param additionalProperties the additional properties
 	 */
 	public void setAdditional(Map<String, Object> additionalProperties) {

spring-boot-project/spring-boot-tools/spring-boot-gradle-plugin/src/main/java/org/springframework/boot/gradle/tasks/bundling/BootArchive.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2017 the original author or authors.
+ * Copyright 2012-2018 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -36,7 +36,6 @@ public interface BootArchive extends Task {
 
 	/**
 	 * Returns the name of the main class of the application.
-	 *
 	 * @return the main class name
 	 */
 	@Input
@@ -45,31 +44,27 @@ public interface BootArchive extends Task {
 
 	/**
 	 * Sets the name of the main class of the application.
-	 *
 	 * @param mainClassName the name of the main class of the application
 	 */
 	void setMainClassName(String mainClassName);
 
 	/**
 	 * Adds Ant-style patterns that identify files that must be unpacked from the archive
 	 * when it is launched.
-	 *
 	 * @param patterns the patterns
 	 */
 	void requiresUnpack(String... patterns);
 
 	/**
 	 * Adds a spec that identifies files that must be unpacked from the archive when it is
 	 * launched.
-	 *
 	 * @param spec the spec
 	 */
 	void requiresUnpack(Spec<FileTreeElement> spec);
 
 	/**
 	 * Returns the {@link LaunchScriptConfiguration} that will control the script that is
 	 * prepended to the archive.
-	 *
 	 * @return the launch script configuration, or {@code null} if the launch script has
 	 * not been configured.
 	 */
@@ -85,14 +80,12 @@ public interface BootArchive extends Task {
 	/**
 	 * Configures the archive to have a prepended launch script, customizing its
 	 * configuration using the given {@code action}.
-	 *
 	 * @param action the action to apply
 	 */
 	void launchScript(Action<LaunchScriptConfiguration> action);
 
 	/**
 	 * Returns the classpath that will be included in the archive.
-	 *
 	 * @return the classpath
 	 */
 	@Optional
@@ -102,15 +95,13 @@ public interface BootArchive extends Task {
 	/**
 	 * Adds files to the classpath to include in the archive. The given {@code classpath}
 	 * are evaluated as per {@link Project#files(Object...)}.
-	 *
 	 * @param classpath the additions to the classpath
 	 */
 	void classpath(Object... classpath);
 
 	/**
 	 * Returns {@code true} if the Devtools jar should be excluded, otherwise
 	 * {@code false}.
-	 *
 	 * @return {@code true} if the Devtools jar should be excluded, or {@code false} if
 	 * not
 	 */
@@ -119,7 +110,6 @@ public interface BootArchive extends Task {
 
 	/**
 	 * Sets whether or not the Devtools jar should be excluded.
-	 *
 	 * @param excludeDevtools {@code true} if the Devtools jar should be excluded, or
 	 * {@code false} if not
 	 */

spring-boot-project/spring-boot-tools/spring-boot-gradle-plugin/src/main/java/org/springframework/boot/gradle/tasks/bundling/BootJar.java

@@ -136,7 +136,6 @@ public void setExcludeDevtools(boolean excludeDevtools) {
 	 * <p>
 	 * By default, any file in {@code BOOT-INF/lib/} is stored and all other files are
 	 * deflated.
-	 *
 	 * @param details the details
 	 * @return the compression to use
 	 */

spring-boot-project/spring-boot-tools/spring-boot-gradle-plugin/src/main/java/org/springframework/boot/gradle/tasks/bundling/BootWar.java

@@ -104,7 +104,6 @@ public void launchScript(Action<LaunchScriptConfiguration> action) {
 	/**
 	 * Returns the provided classpath, the contents of which will be included in the
 	 * {@code WEB-INF/lib-provided} directory of the war.
-	 *
 	 * @return the provided classpath
 	 */
 	@Optional
@@ -116,7 +115,6 @@ public FileCollection getProvidedClasspath() {
 	 * Adds files to the provided classpath to include in the {@code WEB-INF/lib-provided}
 	 * directory of the war. The given {@code classpath} are evaluated as per
 	 * {@link Project#files(Object...)}.
-	 *
 	 * @param classpath the additions to the classpath
 	 */
 	public void providedClasspath(Object... classpath) {
@@ -142,7 +140,6 @@ public void setExcludeDevtools(boolean excludeDevtools) {
 	 * <p>
 	 * By default, any file in {@code WEB-INF/lib/} or {@code WEB-INF/lib-provided/} is
 	 * stored and all other files are deflated.
-	 *
 	 * @param details the details
 	 * @return the compression to use
 	 */

spring-boot-project/spring-boot-tools/spring-boot-gradle-plugin/src/main/java/org/springframework/boot/gradle/tasks/bundling/LaunchScriptConfiguration.java

@@ -40,7 +40,6 @@ public class LaunchScriptConfiguration implements Serializable {
 	/**
 	 * Returns the properties that are applied to the launch script when it's being
 	 * including in the executable archive.
-	 *
 	 * @return the properties
 	 */
 	public Map<String, String> getProperties() {
@@ -50,7 +49,6 @@ public Map<String, String> getProperties() {
 	/**
 	 * Sets the properties that are applied to the launch script when it's being including
 	 * in the executable archive.
-	 *
 	 * @param properties the properties
 	 */
 	public void properties(Map<String, String> properties) {
@@ -60,7 +58,6 @@ public void properties(Map<String, String> properties) {
 	/**
 	 * Returns the script {@link File} that will be included in the executable archive.
 	 * When {@code null}, the default launch script will be used.
-	 *
 	 * @return the script file
 	 */
 	public File getScript() {
@@ -70,7 +67,6 @@ public File getScript() {
 	/**
 	 * Sets the script {@link File} that will be included in the executable archive. When
 	 * {@code null}, the default launch script will be used.
-	 *
 	 * @param script the script file
 	 */
 	public void setScript(File script) {