Polish JavaDoc

spring-bootstrap-samples/spring-bootstrap-data-sample/src/test/java/org/springframework/bootstrap/sample/data/DataBootstrapApplicationTests.java

@@ -23,7 +23,6 @@ import static org.junit.Assert.assertEquals;
  * Basic integration tests for service demo application.
  * 
  * @author Dave Syer
- * 
  */
 public class DataBootstrapApplicationTests {
 

spring-bootstrap/src/main/java/org/springframework/bootstrap/CommandLineRunner.java

@@ -32,6 +32,7 @@ public interface CommandLineRunner {
 	/**
 	 * Callback used to run the bean.
 	 * @param args incoming main method arguments
+	 * @throws Exception on error
 	 */
 	void run(String... args) throws Exception;
 

spring-bootstrap/src/main/java/org/springframework/bootstrap/SpringApplication.java

@@ -389,6 +389,7 @@ public class SpringApplication {
 	/**
 	 * Load beans into the application context.
 	 * @param context the context to load beans into
+	 * @param sources the sources to load
 	 */
 	protected void load(ApplicationContext context, Object[] sources) {
 		Assert.isInstanceOf(BeanDefinitionRegistry.class, context);
@@ -408,6 +409,9 @@ public class SpringApplication {
 
 	/**
 	 * Factory method used to create the {@link BeanDefinitionLoader}.
+	 * @param registry the bean definition registry
+	 * @param sources the sources to load
+	 * @return the {@link BeanDefinitionLoader} that will be used to load beans
 	 */
 	protected BeanDefinitionLoader createBeanDefinitionLoader(
 			BeanDefinitionRegistry registry, Object[] sources) {
@@ -439,6 +443,7 @@ public class SpringApplication {
 	/**
 	 * Sets if this application is running within a web environment. If not specified will
 	 * attempt to deduce the environment based on the classpath.
+	 * @param webEnvironment if the application is running in a web environment
 	 */
 	public void setWebEnvironment(boolean webEnvironment) {
 		this.webEnvironment = webEnvironment;
@@ -447,6 +452,7 @@ public class SpringApplication {
 	/**
 	 * Sets if the Spring banner should be displayed when the application runs. Defaults
 	 * to {@code true}.
+	 * @param showBanner if the banner should be shown
 	 * @see #printBanner()
 	 */
 	public void setShowBanner(boolean showBanner) {
@@ -456,6 +462,7 @@ public class SpringApplication {
 	/**
 	 * Sets if a {@link CommandLinePropertySource} should be added to the application
 	 * context in order to expose arguments. Defaults to {@code true}.
+	 * @param addCommandLineProperties if command line arguments should be exposed
 	 */
 	public void setAddCommandLineProperties(boolean addCommandLineProperties) {
 		this.addCommandLineProperties = addCommandLineProperties;
@@ -472,6 +479,7 @@ public class SpringApplication {
 
 	/**
 	 * Sets the bean name generator that should be used when generating bean names.
+	 * @param beanNameGenerator the bean name generator
 	 */
 	public void setBeanNameGenerator(BeanNameGenerator beanNameGenerator) {
 		this.beanNameGenerator = beanNameGenerator;
@@ -479,6 +487,7 @@ public class SpringApplication {
 
 	/**
 	 * Sets the underlying environment that should be used when loading.
+	 * @param environment the environment
 	 */
 	public void setEnvironment(ConfigurableEnvironment environment) {
 		this.environment = environment;
@@ -486,6 +495,7 @@ public class SpringApplication {
 
 	/**
 	 * Sets the {@link ResourceLoader} that should be used when loading resources.
+	 * @param resourceLoader the resource loader
 	 */
 	public void setResourceLoader(ResourceLoader resourceLoader) {
 		Assert.notNull(resourceLoader, "ResourceLoader must not be null");
@@ -517,6 +527,8 @@ public class SpringApplication {
 	}
 
 	/**
+	 * Sets the {@link ApplicationContextInitializer} that will be applied to the Spring
+	 * {@link ApplicationContext}. Any existing initializers will be replaced.
 	 * @param initializers the initializers to set
 	 */
 	public void setInitializers(
@@ -525,13 +537,17 @@ public class SpringApplication {
 	}
 
 	/**
-	 * @param initializers
+	 * Add {@link ApplicationContextInitializer}s to be applied to the Spring
+	 * {@link ApplicationContext} .
+	 * @param initializers the initializers to add
 	 */
 	public void addInitializers(ApplicationContextInitializer<?>... initializers) {
 		this.initializers.addAll(Arrays.asList(initializers));
 	}
 
 	/**
+	 * Returns a mutable list of the {@link ApplicationContextInitializer}s that will be
+	 * applied to the Spring {@link ApplicationContext}.
 	 * @return the initializers
 	 */
 	public List<ApplicationContextInitializer<?>> getInitializers() {

spring-bootstrap/src/main/java/org/springframework/bootstrap/autoconfigure/batch/JobExecutionEvent.java

@@ -27,7 +27,7 @@ public class JobExecutionEvent extends ApplicationEvent {
 	private JobExecution execution;
 
 	/**
-	 * @param execution
+	 * @param execution the job execution
 	 */
 	public JobExecutionEvent(JobExecution execution) {
 		super(execution);

spring-bootstrap/src/main/java/org/springframework/bootstrap/bind/CustomPropertyConstructor.java

@@ -60,6 +60,9 @@ public class CustomPropertyConstructor extends Constructor {
 	/**
 	 * Adds an alias for a Javabean property name on a particular type. The values of YAML
 	 * keys with the alias name will be mapped to the Javabean property.
+	 * @param alias the alias to map
+	 * @param type the type of property
+	 * @param name the property name
 	 */
 	protected final void addPropertyAlias(String alias, Class<?> type, String name) {
 		Map<String, Property> typeMap = this.properties.get(type);

spring-bootstrap/src/main/java/org/springframework/bootstrap/bind/PropertiesConfigurationFactory.java

@@ -97,7 +97,7 @@ public class PropertiesConfigurationFactory<T> implements FactoryBean<T>,
 	 * <p>
 	 * Default is "true". Turn this off to enforce that all bind parameters must have a
 	 * matching field in the target object.
-	 * <p>
+	 * @param ignoreUnknownFields if unknown fields should be ignored
 	 */
 	public void setIgnoreUnknownFields(boolean ignoreUnknownFields) {
 		this.ignoreUnknownFields = ignoreUnknownFields;
@@ -110,14 +110,14 @@ public class PropertiesConfigurationFactory<T> implements FactoryBean<T>,
 	 * <p>
 	 * Default is "false". Turn this on to ignore bind parameters for nested objects in
 	 * non-existing parts of the target object graph.
-	 * <p>
+	 * @param ignoreInvalidFields if invalid fields should be ignored
 	 */
 	public void setIgnoreInvalidFields(boolean ignoreInvalidFields) {
 		this.ignoreInvalidFields = ignoreInvalidFields;
 	}
 
 	/**
-	 * @param targetName
+	 * @param targetName the target name to set
 	 */
 	public void setTargetName(String targetName) {
 		this.targetName = targetName;

spring-bootstrap/src/main/java/org/springframework/bootstrap/bind/YamlConfigurationFactory.java

@@ -71,6 +71,7 @@ public class YamlConfigurationFactory<T> implements FactoryBean<T>, MessageSourc
 	/**
 	 * Sets a validation constructor which will be applied to the YAML doc to see whether
 	 * it matches the expected Javabean.
+	 * @param type the root type
 	 */
 	public YamlConfigurationFactory(Class<?> type) {
 		Assert.notNull(type);