From 4d9111606ba7061e24eec0c2cf6913d641b27f11 Mon Sep 17 00:00:00 2001 From: Johnny Lim Date: Thu, 12 Nov 2015 22:33:29 +0900 Subject: [PATCH] Polish docs Closes gh-4446 --- .../src/main/asciidoc/appendix-application-properties.adoc | 4 ++-- .../src/main/asciidoc/appendix-configuration-metadata.adoc | 2 +- spring-boot-docs/src/main/asciidoc/howto.adoc | 2 +- .../sample/data/gemfire/SampleDataGemFireApplication.java | 2 +- .../boot/bind/PropertiesConfigurationFactory.java | 2 +- .../boot/bind/PropertySourcesPropertyValues.java | 2 +- .../springframework/boot/bind/YamlConfigurationFactory.java | 2 +- .../boot/bind/YamlJavaBeanPropertyConstructor.java | 6 +++--- .../springframework/boot/logging/AbstractLoggingSystem.java | 2 +- 9 files changed, 12 insertions(+), 12 deletions(-) diff --git a/spring-boot-docs/src/main/asciidoc/appendix-application-properties.adoc b/spring-boot-docs/src/main/asciidoc/appendix-application-properties.adoc index 2553f66640..484b63d1ac 100644 --- a/spring-boot-docs/src/main/asciidoc/appendix-application-properties.adoc +++ b/spring-boot-docs/src/main/asciidoc/appendix-application-properties.adoc @@ -72,7 +72,7 @@ content into your application; rather pick only the properties that you need. spring.cache.type= # Cache type, auto-detected according to the environment by default. # SPRING CONFIG ({sc-spring-boot}/context/config/ConfigFileApplicationListener.{sc-ext}[ConfigFileApplicationListener]) - spring.config.location= # Config file locations. TODO + spring.config.location= # Config file locations. spring.config.name=application # Config file name. # HAZELCAST ({sc-spring-boot-autoconfigure}/hazelcast/HazelcastProperties.{sc-ext}[HazelcastProperties]) @@ -606,7 +606,7 @@ content into your application; rather pick only the properties that you need. spring.jta.bitronix.connectionfactory.password= # The password to use to connect to the JMS provider. spring.jta.bitronix.connectionfactory.share-transaction-connections=false # Whether or not connections in the ACCESSIBLE state can be shared within the context of a transaction. spring.jta.bitronix.connectionfactory.test-connections=true # Whether or not connections should be tested when acquired from the pool. - spring.jta.bitronix.connectionfactory.two-pc-ordering-position=1 # The postion that this resource should take during two-phase commit (always first is Integer.MIN_VALUE, always last is Integer.MAX_VALUE). + spring.jta.bitronix.connectionfactory.two-pc-ordering-position=1 # The position that this resource should take during two-phase commit (always first is Integer.MIN_VALUE, always last is Integer.MAX_VALUE). spring.jta.bitronix.connectionfactory.unique-name=jmsConnectionFactory # The unique name used to identify the resource during recovery. spring.jta.bitronix.connectionfactory.use-tm-join=true Whether or not TMJOIN should be used when starting XAResources. spring.jta.bitronix.connectionfactory.user= # The user to use to connect to the JMS provider. diff --git a/spring-boot-docs/src/main/asciidoc/appendix-configuration-metadata.adoc b/spring-boot-docs/src/main/asciidoc/appendix-configuration-metadata.adoc index f2aa6e4507..6c458ec4c9 100644 --- a/spring-boot-docs/src/main/asciidoc/appendix-configuration-metadata.adoc +++ b/spring-boot-docs/src/main/asciidoc/appendix-configuration-metadata.adoc @@ -700,7 +700,7 @@ NOTE: You need to add `compileJava.dependsOn(processResources)` to your build to that resources are processed before code is compiled. Without this directive any `additional-spring-configuration-metadata.json` files will not be processed. -The processor will pickup both classes and methods that are annotated with +The processor will pick up both classes and methods that are annotated with `@ConfigurationProperties`. The Javadoc for field values within configuration classes will be used to populate the `description` attribute. diff --git a/spring-boot-docs/src/main/asciidoc/howto.adoc b/spring-boot-docs/src/main/asciidoc/howto.adoc index e6677de70d..c79f7107b4 100644 --- a/spring-boot-docs/src/main/asciidoc/howto.adoc +++ b/spring-boot-docs/src/main/asciidoc/howto.adoc @@ -1621,7 +1621,7 @@ not something you want to be on the classpath in production. It is a Hibernate f (nothing to do with Spring). -[[howto-intialize-a-database-using-spring-jdbc]] +[[howto-initialize-a-database-using-spring-jdbc]] === Initialize a database using Spring JDBC Spring JDBC has a `DataSource` initializer feature. Spring Boot enables it by default and loads SQL from the standard locations `schema.sql` and `data.sql` (in the root of the diff --git a/spring-boot-samples/spring-boot-sample-data-gemfire/src/main/java/sample/data/gemfire/SampleDataGemFireApplication.java b/spring-boot-samples/spring-boot-sample-data-gemfire/src/main/java/sample/data/gemfire/SampleDataGemFireApplication.java index 2dd9780a84..2fdbc4bdb8 100644 --- a/spring-boot-samples/spring-boot-sample-data-gemfire/src/main/java/sample/data/gemfire/SampleDataGemFireApplication.java +++ b/spring-boot-samples/spring-boot-sample-data-gemfire/src/main/java/sample/data/gemfire/SampleDataGemFireApplication.java @@ -23,7 +23,7 @@ import org.springframework.data.gemfire.repository.config.EnableGemfireRepositor import org.springframework.transaction.annotation.EnableTransactionManagement; /** - * The GemstoneAppConfiguration class for allowing Spring Boot to pickup additional + * The GemstoneAppConfiguration class for allowing Spring Boot to pick up additional * application Spring configuration meta-data for GemFire, which must be specified in * Spring Data GemFire's XML namespace. * diff --git a/spring-boot/src/main/java/org/springframework/boot/bind/PropertiesConfigurationFactory.java b/spring-boot/src/main/java/org/springframework/boot/bind/PropertiesConfigurationFactory.java index db9b7490e7..d9718ab393 100644 --- a/spring-boot/src/main/java/org/springframework/boot/bind/PropertiesConfigurationFactory.java +++ b/spring-boot/src/main/java/org/springframework/boot/bind/PropertiesConfigurationFactory.java @@ -353,7 +353,7 @@ public class PropertiesConfigurationFactory } /** - * Customize the databinder. + * Customize the data binder. * @param dataBinder the data binder that will be used to bind and validate */ protected void customizeBinder(DataBinder dataBinder) { diff --git a/spring-boot/src/main/java/org/springframework/boot/bind/PropertySourcesPropertyValues.java b/spring-boot/src/main/java/org/springframework/boot/bind/PropertySourcesPropertyValues.java index d1d4b6d409..ec660bf713 100644 --- a/spring-boot/src/main/java/org/springframework/boot/bind/PropertySourcesPropertyValues.java +++ b/spring-boot/src/main/java/org/springframework/boot/bind/PropertySourcesPropertyValues.java @@ -161,7 +161,7 @@ public class PropertySourcesPropertyValues implements PropertyValues { value = resolver.getProperty(propertyName, Object.class); } catch (RuntimeException ex) { - // Probably could not convert to Object, weird, but ignoreable + // Probably could not convert to Object, weird, but ignorable } if (value == null) { value = source.getProperty(propertyName.toUpperCase()); diff --git a/spring-boot/src/main/java/org/springframework/boot/bind/YamlConfigurationFactory.java b/spring-boot/src/main/java/org/springframework/boot/bind/YamlConfigurationFactory.java index 8489dbeda4..d4c65427fe 100644 --- a/spring-boot/src/main/java/org/springframework/boot/bind/YamlConfigurationFactory.java +++ b/spring-boot/src/main/java/org/springframework/boot/bind/YamlConfigurationFactory.java @@ -72,7 +72,7 @@ public class YamlConfigurationFactory /** * Sets a validation constructor which will be applied to the YAML doc to see whether - * it matches the expected Javabean. + * it matches the expected JavaBean. * @param type the root type */ public YamlConfigurationFactory(Class type) { diff --git a/spring-boot/src/main/java/org/springframework/boot/bind/YamlJavaBeanPropertyConstructor.java b/spring-boot/src/main/java/org/springframework/boot/bind/YamlJavaBeanPropertyConstructor.java index dd9897ea49..653cf46d46 100644 --- a/spring-boot/src/main/java/org/springframework/boot/bind/YamlJavaBeanPropertyConstructor.java +++ b/spring-boot/src/main/java/org/springframework/boot/bind/YamlJavaBeanPropertyConstructor.java @@ -27,7 +27,7 @@ import org.yaml.snakeyaml.nodes.NodeId; /** * Extended version of snakeyaml's Constructor class to facilitate mapping custom YAML - * keys to Javabean property names. + * keys to JavaBean property names. * * @author Luke Taylor */ @@ -57,8 +57,8 @@ public class YamlJavaBeanPropertyConstructor 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. + * 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 diff --git a/spring-boot/src/main/java/org/springframework/boot/logging/AbstractLoggingSystem.java b/spring-boot/src/main/java/org/springframework/boot/logging/AbstractLoggingSystem.java index 111368ee2c..10c652598f 100644 --- a/spring-boot/src/main/java/org/springframework/boot/logging/AbstractLoggingSystem.java +++ b/spring-boot/src/main/java/org/springframework/boot/logging/AbstractLoggingSystem.java @@ -149,7 +149,7 @@ public abstract class AbstractLoggingSystem extends LoggingSystem { /** * Reinitialize the logging system if required. Called when * {@link #getSelfInitializationConfig()} is used and the log file hasn't changed. May - * be used to reload configuration (for example to pickup additional System + * be used to reload configuration (for example to pick up additional System * properties). * @param initializationContext the logging initialization context */