Polish Javadoc

This commit is contained in:
Phillip Webb
2015-09-06 00:28:00 -07:00
parent e07df7e4c6
commit e674d751de
252 changed files with 680 additions and 348 deletions

View File

@@ -217,8 +217,8 @@ public abstract class AbstractRunMojo extends AbstractDependencyFilterMojo {
/**
* Run with a forked VM, using the specified command line arguments.
* @param args the arguments (JVM arguments and application arguments)
* @throws MojoExecutionException
* @throws MojoFailureException
* @throws MojoExecutionException in case of MOJO execution errors
* @throws MojoFailureException in case of MOJO failures
*/
protected abstract void runWithForkedJvm(List<String> args)
throws MojoExecutionException, MojoFailureException;
@@ -227,8 +227,8 @@ public abstract class AbstractRunMojo extends AbstractDependencyFilterMojo {
* Run with the current VM, using the specified arguments.
* @param startClassName the class to run
* @param arguments the class arguments
* @throws MojoExecutionException
* @throws MojoFailureException
* @throws MojoExecutionException in case of MOJO execution errors
* @throws MojoFailureException in case of MOJO failures
*/
protected abstract void runWithMavenJvm(String startClassName, String... arguments)
throws MojoExecutionException, MojoFailureException;

View File

@@ -33,7 +33,7 @@ import org.springframework.boot.loader.tools.LibraryCallback;
import org.springframework.boot.loader.tools.LibraryScope;
/**
* {@link Libraries} backed by Maven {@link Artifact}s
* {@link Libraries} backed by Maven {@link Artifact}s.
*
* @author Phillip Webb
* @author Andy Wilkinson

View File

@@ -40,7 +40,7 @@ abstract class FilterableDependency {
private String artifactId;
/**
* The classifier of the artifact to exclude
* The classifier of the artifact to exclude.
*/
@Parameter
private String classifier;

View File

@@ -41,7 +41,8 @@ public class PropertiesMergingResourceTransformer implements ResourceTransformer
private final Properties data = new Properties();
/**
* @return the data the properties being merged
* Return the data the properties being merged.
* @return the data
*/
public Properties getData() {
return this.data;

View File

@@ -235,35 +235,38 @@ public class RepackageMojo extends AbstractDependencyFilterMojo {
return null;
}
/**
* Archive layout types.
*/
public enum LayoutType {
/**
* Jar Layout
* Jar Layout.
*/
JAR(new Layouts.Jar()),
/**
* War Layout
* War Layout.
*/
WAR(new Layouts.War()),
/**
* Zip Layout
* Zip Layout.
*/
ZIP(new Layouts.Expanded()),
/**
* Dir Layout
* Dir Layout.
*/
DIR(new Layouts.Expanded()),
/**
* Module Layout
* Module Layout.
*/
MODULE(new Layouts.Module()),
/**
* No Layout
* No Layout.
*/
NONE(new Layouts.None());

View File

@@ -250,12 +250,13 @@ public class StartMojo extends AbstractRunMojo {
/**
* Execute a task, retrying it on failure.
* @param <T> the result type
* @param wait the wait time
* @param maxAttempts the maximum number of attempts
* @param callback the task to execute (possibly multiple times). The callback should
* return {@code null} to indicate that another attempt should be made
* @return the result
* @throws Exception
* @throws Exception in case of execution errors
*/
public <T> T execute(long wait, int maxAttempts, Callable<T> callback)
throws Exception {