Polish Javadoc

spring-boot-tools/spring-boot-configuration-processor/src/main/java/org/springframework/boot/configurationprocessor/MetadataStore.java

@@ -33,7 +33,7 @@ import org.springframework.boot.configurationprocessor.metadata.InvalidConfigura
 import org.springframework.boot.configurationprocessor.metadata.JsonMarshaller;
 
 /**
- * A {@code MetadataStore} is responsible for the storage of metadata on the filesystem
+ * A {@code MetadataStore} is responsible for the storage of metadata on the filesystem.
  *
  * @author Andy Wilkinson
  * @since 1.2.2

spring-boot-tools/spring-boot-configuration-processor/src/main/java/org/springframework/boot/configurationprocessor/fieldvalues/javac/JavaCompilerFieldValuesParser.java

@@ -54,6 +54,9 @@ public class JavaCompilerFieldValuesParser implements FieldValuesParser {
 		return Collections.emptyMap();
 	}
 
+	/**
+	 * {@link TreeVisitor} to collect fields.
+	 */
 	private static class FieldCollector implements TreeVisitor {
 
 		private static final Map<String, Class<?>> WRAPPER_TYPES;

spring-boot-tools/spring-boot-configuration-processor/src/main/java/org/springframework/boot/configurationprocessor/metadata/ConfigurationMetadata.java

@@ -84,14 +84,16 @@ public class ConfigurationMetadata {
 	}
 
 	/**
-	 * @return the meta-data properties.
+	 * Return item meta-data.
+	 * @return the items
 	 */
 	public List<ItemMetadata> getItems() {
 		return flattenValues(this.items);
 	}
 
 	/**
-	 * @return the meta-data hints.
+	 * Return hint meta-data.
+	 * @return the hints
 	 */
 	public List<ItemHint> getHints() {
 		return flattenValues(this.hints);

spring-boot-tools/spring-boot-configuration-processor/src/main/java/org/springframework/boot/configurationprocessor/metadata/ItemHint.java

@@ -88,6 +88,9 @@ public class ItemHint implements Comparable<ItemHint> {
 				+ ", providers=" + this.providers + '}';
 	}
 
+	/**
+	 * A hint for a value.
+	 */
 	public static class ValueHint {
 
 		private final Object value;
@@ -115,6 +118,9 @@ public class ItemHint implements Comparable<ItemHint> {
 
 	}
 
+	/**
+	 * A value provider.
+	 */
 	public static class ValueProvider {
 
 		private final String name;

spring-boot-tools/spring-boot-configuration-processor/src/main/java/org/springframework/boot/configurationprocessor/metadata/ItemMetadata.java

@@ -172,7 +172,17 @@ public class ItemMetadata implements Comparable<ItemMetadata> {
 	 * The item type.
 	 */
 	public enum ItemType {
-		GROUP, PROPERTY
+
+		/**
+		 * Group item type.
+		 */
+		GROUP,
+
+		/**
+		 * Property item type.
+		 */
+		PROPERTY
+
 	}
 
 }

spring-boot-tools/spring-boot-configuration-processor/src/test/java/org/springframework/boot/configurationprocessor/TestProject.java

@@ -160,7 +160,7 @@ public class TestProject {
 	/**
 	 * Restore source code of given class to its original contents.
 	 * @param type the class to revert
-	 * @throws IOException
+	 * @throws IOException in case of I/O errors
 	 */
 	public void revert(Class<?> type) throws IOException {
 		Assert.assertTrue(getSourceFile(type).exists());
@@ -170,7 +170,7 @@ public class TestProject {
 	/**
 	 * Add source code of given class to this project.
 	 * @param type the class to add
-	 * @throws IOException
+	 * @throws IOException in case of I/O errors
 	 */
 	public void add(Class<?> type) throws IOException {
 		Assert.assertFalse(getSourceFile(type).exists());