Commit 8d1e69bc authored by Andy Wilkinson's avatar Andy Wilkinson

Polish Gradle plugin's javadoc

parent 703de648
...@@ -44,7 +44,6 @@ public class SpringBootExtension { ...@@ -44,7 +44,6 @@ public class SpringBootExtension {
/** /**
* Creates a new {@code SpringBootPluginExtension} that is associated with the given * Creates a new {@code SpringBootPluginExtension} that is associated with the given
* {@code project}. * {@code project}.
*
* @param project the project * @param project the project
*/ */
public SpringBootExtension(Project project) { public SpringBootExtension(Project project) {
...@@ -53,7 +52,6 @@ public class SpringBootExtension { ...@@ -53,7 +52,6 @@ public class SpringBootExtension {
/** /**
* Returns the main class name of the application. * Returns the main class name of the application.
*
* @return the name of the application's main class * @return the name of the application's main class
*/ */
public String getMainClassName() { public String getMainClassName() {
...@@ -62,7 +60,6 @@ public class SpringBootExtension { ...@@ -62,7 +60,6 @@ public class SpringBootExtension {
/** /**
* Sets the main class name of the application. * Sets the main class name of the application.
*
* @param mainClassName the name of the application's main class * @param mainClassName the name of the application's main class
*/ */
public void setMainClassName(String mainClassName) { public void setMainClassName(String mainClassName) {
...@@ -89,7 +86,6 @@ public class SpringBootExtension { ...@@ -89,7 +86,6 @@ public class SpringBootExtension {
* By default, the task's destination dir will be a directory named {@code META-INF} * 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 * 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. * artifact will be the base name of the {@code bootWar} or {@code bootJar} task.
*
* @param configurer the task configurer * @param configurer the task configurer
*/ */
public void buildInfo(Action<BuildInfo> configurer) { public void buildInfo(Action<BuildInfo> configurer) {
......
...@@ -31,7 +31,6 @@ interface PluginApplicationAction extends Action<Project> { ...@@ -31,7 +31,6 @@ interface PluginApplicationAction extends Action<Project> {
/** /**
* The class of the {@code Plugin} that, when applied, will trigger the execution of * 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. * this action. May return {@code null} if the plugin class is not on the classpath.
*
* @return the plugin class or {@code null} * @return the plugin class or {@code null}
*/ */
Class<? extends Plugin<? extends Project>> getPluginClass(); Class<? extends Plugin<? extends Project>> getPluginClass();
......
...@@ -55,14 +55,12 @@ public class SpringBootPlugin implements Plugin<Project> { ...@@ -55,14 +55,12 @@ public class SpringBootPlugin implements Plugin<Project> {
/** /**
* The name of the default {@link BootJar} task. * The name of the default {@link BootJar} task.
*
* @since 2.0.0 * @since 2.0.0
*/ */
public static final String BOOT_JAR_TASK_NAME = "bootJar"; public static final String BOOT_JAR_TASK_NAME = "bootJar";
/** /**
* The name of the default {@link BootWar} task. * The name of the default {@link BootWar} task.
*
* @since 2.0.0 * @since 2.0.0
*/ */
public static final String BOOT_WAR_TASK_NAME = "bootWar"; public static final String BOOT_WAR_TASK_NAME = "bootWar";
......
...@@ -24,6 +24,7 @@ import org.gradle.jvm.application.tasks.CreateStartScripts; ...@@ -24,6 +24,7 @@ import org.gradle.jvm.application.tasks.CreateStartScripts;
* main class name} optional. * main class name} optional.
* *
* @author Andy Wilkinson * @author Andy Wilkinson
* @since 2.0.0
*/ */
public class CreateBootStartScripts extends CreateStartScripts { public class CreateBootStartScripts extends CreateStartScripts {
......
...@@ -39,6 +39,7 @@ import org.springframework.boot.loader.tools.BuildPropertiesWriter.ProjectDetail ...@@ -39,6 +39,7 @@ import org.springframework.boot.loader.tools.BuildPropertiesWriter.ProjectDetail
* {@code Project}. * {@code Project}.
* *
* @author Andy Wilkinson * @author Andy Wilkinson
* @since 2.0.0
*/ */
public class BuildInfo extends ConventionTask { public class BuildInfo extends ConventionTask {
...@@ -73,7 +74,6 @@ public class BuildInfo extends ConventionTask { ...@@ -73,7 +74,6 @@ public class BuildInfo extends ConventionTask {
/** /**
* Returns the directory to which the {@code build-info.properties} file will be * Returns the directory to which the {@code build-info.properties} file will be
* written. Defaults to the {@link Project#getBuildDir() Project's build directory}. * written. Defaults to the {@link Project#getBuildDir() Project's build directory}.
*
* @return the destination directory * @return the destination directory
*/ */
@OutputDirectory @OutputDirectory
......
...@@ -27,6 +27,7 @@ import org.gradle.api.Project; ...@@ -27,6 +27,7 @@ import org.gradle.api.Project;
* The properties that are written into the {@code build-info.properties} file. * The properties that are written into the {@code build-info.properties} file.
* *
* @author Andy Wilkinson * @author Andy Wilkinson
* @since 2.0.0
*/ */
@SuppressWarnings("serial") @SuppressWarnings("serial")
public class BuildInfoProperties implements Serializable { public class BuildInfoProperties implements Serializable {
...@@ -53,7 +54,6 @@ 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 * Returns the value used for the {@code build.group} property. Defaults to the
* {@link Project#getGroup() Project's group}. * {@link Project#getGroup() Project's group}.
*
* @return the group * @return the group
*/ */
public String getGroup() { public String getGroup() {
...@@ -65,7 +65,6 @@ public class BuildInfoProperties implements Serializable { ...@@ -65,7 +65,6 @@ public class BuildInfoProperties implements Serializable {
/** /**
* Sets the value used for the {@code build.group} property. * Sets the value used for the {@code build.group} property.
*
* @param group the group name * @param group the group name
*/ */
public void setGroup(String group) { public void setGroup(String group) {
...@@ -74,7 +73,6 @@ public class BuildInfoProperties implements Serializable { ...@@ -74,7 +73,6 @@ public class BuildInfoProperties implements Serializable {
/** /**
* Returns the value used for the {@code build.artifact} property. * Returns the value used for the {@code build.artifact} property.
*
* @return the artifact * @return the artifact
*/ */
public String getArtifact() { public String getArtifact() {
...@@ -83,7 +81,6 @@ public class BuildInfoProperties implements Serializable { ...@@ -83,7 +81,6 @@ public class BuildInfoProperties implements Serializable {
/** /**
* Sets the value used for the {@code build.artifact} property. * Sets the value used for the {@code build.artifact} property.
*
* @param artifact the artifact * @param artifact the artifact
*/ */
public void setArtifact(String artifact) { public void setArtifact(String artifact) {
...@@ -93,7 +90,6 @@ public class BuildInfoProperties implements Serializable { ...@@ -93,7 +90,6 @@ public class BuildInfoProperties implements Serializable {
/** /**
* Returns the value used for the {@code build.version} property. Defaults to the * Returns the value used for the {@code build.version} property. Defaults to the
* {@link Project#getVersion() Project's version}. * {@link Project#getVersion() Project's version}.
*
* @return the version * @return the version
*/ */
public String getVersion() { public String getVersion() {
...@@ -105,7 +101,6 @@ public class BuildInfoProperties implements Serializable { ...@@ -105,7 +101,6 @@ public class BuildInfoProperties implements Serializable {
/** /**
* Sets the value used for the {@code build.version} property. * Sets the value used for the {@code build.version} property.
*
* @param version the version * @param version the version
*/ */
public void setVersion(String version) { public void setVersion(String version) {
...@@ -115,7 +110,6 @@ public class BuildInfoProperties implements Serializable { ...@@ -115,7 +110,6 @@ public class BuildInfoProperties implements Serializable {
/** /**
* Returns the value used for the {@code build.name} property. Defaults to the * Returns the value used for the {@code build.name} property. Defaults to the
* {@link Project#getDisplayName() Project's display name}. * {@link Project#getDisplayName() Project's display name}.
*
* @return the name * @return the name
*/ */
public String getName() { public String getName() {
...@@ -127,7 +121,6 @@ public class BuildInfoProperties implements Serializable { ...@@ -127,7 +121,6 @@ public class BuildInfoProperties implements Serializable {
/** /**
* Sets the value used for the {@code build.name} property. * Sets the value used for the {@code build.name} property.
*
* @param name the name * @param name the name
*/ */
public void setName(String name) { public void setName(String name) {
...@@ -154,7 +147,6 @@ public class BuildInfoProperties implements Serializable { ...@@ -154,7 +147,6 @@ public class BuildInfoProperties implements Serializable {
/** /**
* Returns the additional properties that will be included. When written, the name of * Returns the additional properties that will be included. When written, the name of
* each additional property is prefixed with {@code build.}. * each additional property is prefixed with {@code build.}.
*
* @return the additional properties * @return the additional properties
*/ */
public Map<String, Object> getAdditional() { public Map<String, Object> getAdditional() {
...@@ -164,7 +156,6 @@ public class BuildInfoProperties implements Serializable { ...@@ -164,7 +156,6 @@ public class BuildInfoProperties implements Serializable {
/** /**
* Sets the additional properties that will be included. When written, the name of * Sets the additional properties that will be included. When written, the name of
* each additional property is prefixed with {@code build.}. * each additional property is prefixed with {@code build.}.
*
* @param additionalProperties the additional properties * @param additionalProperties the additional properties
*/ */
public void setAdditional(Map<String, Object> additionalProperties) { public void setAdditional(Map<String, Object> additionalProperties) {
......
/* /*
* 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"); * Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License. * you may not use this file except in compliance with the License.
...@@ -36,7 +36,6 @@ public interface BootArchive extends Task { ...@@ -36,7 +36,6 @@ public interface BootArchive extends Task {
/** /**
* Returns the name of the main class of the application. * Returns the name of the main class of the application.
*
* @return the main class name * @return the main class name
*/ */
@Input @Input
...@@ -45,7 +44,6 @@ public interface BootArchive extends Task { ...@@ -45,7 +44,6 @@ public interface BootArchive extends Task {
/** /**
* Sets the name of the main class of the application. * Sets the name of the main class of the application.
*
* @param mainClassName the name of the main class of the application * @param mainClassName the name of the main class of the application
*/ */
void setMainClassName(String mainClassName); void setMainClassName(String mainClassName);
...@@ -53,7 +51,6 @@ public interface BootArchive extends Task { ...@@ -53,7 +51,6 @@ public interface BootArchive extends Task {
/** /**
* Adds Ant-style patterns that identify files that must be unpacked from the archive * Adds Ant-style patterns that identify files that must be unpacked from the archive
* when it is launched. * when it is launched.
*
* @param patterns the patterns * @param patterns the patterns
*/ */
void requiresUnpack(String... patterns); void requiresUnpack(String... patterns);
...@@ -61,7 +58,6 @@ public interface BootArchive extends Task { ...@@ -61,7 +58,6 @@ public interface BootArchive extends Task {
/** /**
* Adds a spec that identifies files that must be unpacked from the archive when it is * Adds a spec that identifies files that must be unpacked from the archive when it is
* launched. * launched.
*
* @param spec the spec * @param spec the spec
*/ */
void requiresUnpack(Spec<FileTreeElement> spec); void requiresUnpack(Spec<FileTreeElement> spec);
...@@ -69,7 +65,6 @@ public interface BootArchive extends Task { ...@@ -69,7 +65,6 @@ public interface BootArchive extends Task {
/** /**
* Returns the {@link LaunchScriptConfiguration} that will control the script that is * Returns the {@link LaunchScriptConfiguration} that will control the script that is
* prepended to the archive. * prepended to the archive.
*
* @return the launch script configuration, or {@code null} if the launch script has * @return the launch script configuration, or {@code null} if the launch script has
* not been configured. * not been configured.
*/ */
...@@ -85,14 +80,12 @@ public interface BootArchive extends Task { ...@@ -85,14 +80,12 @@ public interface BootArchive extends Task {
/** /**
* Configures the archive to have a prepended launch script, customizing its * Configures the archive to have a prepended launch script, customizing its
* configuration using the given {@code action}. * configuration using the given {@code action}.
*
* @param action the action to apply * @param action the action to apply
*/ */
void launchScript(Action<LaunchScriptConfiguration> action); void launchScript(Action<LaunchScriptConfiguration> action);
/** /**
* Returns the classpath that will be included in the archive. * Returns the classpath that will be included in the archive.
*
* @return the classpath * @return the classpath
*/ */
@Optional @Optional
...@@ -102,7 +95,6 @@ public interface BootArchive extends Task { ...@@ -102,7 +95,6 @@ public interface BootArchive extends Task {
/** /**
* Adds files to the classpath to include in the archive. The given {@code classpath} * Adds files to the classpath to include in the archive. The given {@code classpath}
* are evaluated as per {@link Project#files(Object...)}. * are evaluated as per {@link Project#files(Object...)}.
*
* @param classpath the additions to the classpath * @param classpath the additions to the classpath
*/ */
void classpath(Object... classpath); void classpath(Object... classpath);
...@@ -110,7 +102,6 @@ public interface BootArchive extends Task { ...@@ -110,7 +102,6 @@ public interface BootArchive extends Task {
/** /**
* Returns {@code true} if the Devtools jar should be excluded, otherwise * Returns {@code true} if the Devtools jar should be excluded, otherwise
* {@code false}. * {@code false}.
*
* @return {@code true} if the Devtools jar should be excluded, or {@code false} if * @return {@code true} if the Devtools jar should be excluded, or {@code false} if
* not * not
*/ */
...@@ -119,7 +110,6 @@ public interface BootArchive extends Task { ...@@ -119,7 +110,6 @@ public interface BootArchive extends Task {
/** /**
* Sets whether or not the Devtools jar should be excluded. * Sets whether or not the Devtools jar should be excluded.
*
* @param excludeDevtools {@code true} if the Devtools jar should be excluded, or * @param excludeDevtools {@code true} if the Devtools jar should be excluded, or
* {@code false} if not * {@code false} if not
*/ */
......
...@@ -136,7 +136,6 @@ public class BootJar extends Jar implements BootArchive { ...@@ -136,7 +136,6 @@ public class BootJar extends Jar implements BootArchive {
* <p> * <p>
* By default, any file in {@code BOOT-INF/lib/} is stored and all other files are * By default, any file in {@code BOOT-INF/lib/} is stored and all other files are
* deflated. * deflated.
*
* @param details the details * @param details the details
* @return the compression to use * @return the compression to use
*/ */
......
...@@ -104,7 +104,6 @@ public class BootWar extends War implements BootArchive { ...@@ -104,7 +104,6 @@ public class BootWar extends War implements BootArchive {
/** /**
* Returns the provided classpath, the contents of which will be included in the * Returns the provided classpath, the contents of which will be included in the
* {@code WEB-INF/lib-provided} directory of the war. * {@code WEB-INF/lib-provided} directory of the war.
*
* @return the provided classpath * @return the provided classpath
*/ */
@Optional @Optional
...@@ -116,7 +115,6 @@ public class BootWar extends War implements BootArchive { ...@@ -116,7 +115,6 @@ public class BootWar extends War implements BootArchive {
* Adds files to the provided classpath to include in the {@code WEB-INF/lib-provided} * 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 * directory of the war. The given {@code classpath} are evaluated as per
* {@link Project#files(Object...)}. * {@link Project#files(Object...)}.
*
* @param classpath the additions to the classpath * @param classpath the additions to the classpath
*/ */
public void providedClasspath(Object... classpath) { public void providedClasspath(Object... classpath) {
...@@ -142,7 +140,6 @@ public class BootWar extends War implements BootArchive { ...@@ -142,7 +140,6 @@ public class BootWar extends War implements BootArchive {
* <p> * <p>
* By default, any file in {@code WEB-INF/lib/} or {@code WEB-INF/lib-provided/} is * By default, any file in {@code WEB-INF/lib/} or {@code WEB-INF/lib-provided/} is
* stored and all other files are deflated. * stored and all other files are deflated.
*
* @param details the details * @param details the details
* @return the compression to use * @return the compression to use
*/ */
......
...@@ -40,7 +40,6 @@ public class LaunchScriptConfiguration implements Serializable { ...@@ -40,7 +40,6 @@ public class LaunchScriptConfiguration implements Serializable {
/** /**
* Returns the properties that are applied to the launch script when it's being * Returns the properties that are applied to the launch script when it's being
* including in the executable archive. * including in the executable archive.
*
* @return the properties * @return the properties
*/ */
public Map<String, String> getProperties() { public Map<String, String> getProperties() {
...@@ -50,7 +49,6 @@ public class LaunchScriptConfiguration implements Serializable { ...@@ -50,7 +49,6 @@ public class LaunchScriptConfiguration implements Serializable {
/** /**
* Sets the properties that are applied to the launch script when it's being including * Sets the properties that are applied to the launch script when it's being including
* in the executable archive. * in the executable archive.
*
* @param properties the properties * @param properties the properties
*/ */
public void properties(Map<String, String> properties) { public void properties(Map<String, String> properties) {
...@@ -60,7 +58,6 @@ public class LaunchScriptConfiguration implements Serializable { ...@@ -60,7 +58,6 @@ public class LaunchScriptConfiguration implements Serializable {
/** /**
* Returns the script {@link File} that will be included in the executable archive. * Returns the script {@link File} that will be included in the executable archive.
* When {@code null}, the default launch script will be used. * When {@code null}, the default launch script will be used.
*
* @return the script file * @return the script file
*/ */
public File getScript() { public File getScript() {
...@@ -70,7 +67,6 @@ public class LaunchScriptConfiguration implements Serializable { ...@@ -70,7 +67,6 @@ public class LaunchScriptConfiguration implements Serializable {
/** /**
* Sets the script {@link File} that will be included in the executable archive. When * Sets the script {@link File} that will be included in the executable archive. When
* {@code null}, the default launch script will be used. * {@code null}, the default launch script will be used.
*
* @param script the script file * @param script the script file
*/ */
public void setScript(File script) { public void setScript(File script) {
......
/* /*
* 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"); * Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License. * you may not use this file except in compliance with the License.
...@@ -34,7 +34,6 @@ public class BootRun extends JavaExec { ...@@ -34,7 +34,6 @@ public class BootRun extends JavaExec {
* {@code sourceSet's} {@link SourceSet#getResources() resources} to the start of the * {@code sourceSet's} {@link SourceSet#getResources() resources} to the start of the
* classpath in place of the {@link SourceSet#getOutput output's} * classpath in place of the {@link SourceSet#getOutput output's}
* {@link SourceSetOutput#getResourcesDir() resources directory}. * {@link SourceSetOutput#getResourcesDir() resources directory}.
*
* @param sourceSet the source set * @param sourceSet the source set
*/ */
public void sourceResources(SourceSet sourceSet) { public void sourceResources(SourceSet sourceSet) {
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment