Polish Javadoc

spring-boot-tools/spring-boot-loader/src/main/java/org/springframework/boot/loader/JavaAgentDetector.java

@@ -19,7 +19,7 @@ package org.springframework.boot.loader;
 import java.net.URL;
 
 /**
- * A strategy for detecting Java agents
+ * A strategy for detecting Java agents.
  *
  * @author Andy Wilkinson
  * @since 1.1.0

spring-boot-tools/spring-boot-loader/src/main/java/org/springframework/boot/loader/Launcher.java

@@ -81,7 +81,7 @@ public abstract class Launcher {
 	}
 
 	/**
-	 * Create a classloader for the specified URLs
+	 * Create a classloader for the specified URLs.
 	 * @param urls the URLs
 	 * @return the classloader
 	 * @throws Exception if the classloader cannot be created

spring-boot-tools/spring-boot-loader/src/main/java/org/springframework/boot/loader/PropertiesLauncher.java

@@ -112,7 +112,7 @@ public class PropertiesLauncher extends Launcher {
 
 	/**
 	 * Properties key for config file location (including optional classpath:, file: or
-	 * URL prefix)
+	 * URL prefix).
 	 */
 	public static final String CONFIG_LOCATION = "loader.config.location";
 

spring-boot-tools/spring-boot-loader/src/main/java/org/springframework/boot/loader/archive/Archive.java

@@ -113,7 +113,7 @@ public abstract class Archive {
 		boolean isDirectory();
 
 		/**
-		 * Returns the name of the entry
+		 * Returns the name of the entry.
 		 * @return the name of the entry
 		 */
 		AsciiBytes getName();

spring-boot-tools/spring-boot-loader/src/main/java/org/springframework/boot/loader/data/RandomAccessDataFile.java

@@ -74,6 +74,7 @@ public class RandomAccessDataFile implements RandomAccessData {
 
 	/**
 	 * Private constructor used to create a {@link #getSubsection(long, long) subsection}.
+	 * @param file the underlying file
 	 * @param pool the underlying pool
 	 * @param offset the offset of the section
 	 * @param length the length of the section
@@ -158,7 +159,7 @@ public class RandomAccessDataFile implements RandomAccessData {
 		 * @param len the length of data to read
 		 * @return the number of bytes read into {@code b} or the actual read byte if
 		 * {@code b} is {@code null}. Returns -1 when the end of the stream is reached
-		 * @throws IOException
+		 * @throws IOException in case of I/O errors
 		 */
 		public int doRead(byte[] b, int off, int len) throws IOException {
 			if (len == 0) {
@@ -213,7 +214,7 @@ public class RandomAccessDataFile implements RandomAccessData {
 		}
 
 		/**
-		 * Move the stream position forwards the specified amount
+		 * Move the stream position forwards the specified amount.
 		 * @param amount the amount to move
 		 * @return the amount moved
 		 */

spring-boot-tools/spring-boot-loader/src/main/java/org/springframework/boot/loader/jar/CentralDirectoryEndRecord.java

@@ -51,7 +51,7 @@ class CentralDirectoryEndRecord {
 	 * {@link RandomAccessData}, searching backwards from the end until a valid block is
 	 * located.
 	 * @param data the source data
-	 * @throws IOException
+	 * @throws IOException in case of I/O errors
 	 */
 	CentralDirectoryEndRecord(RandomAccessData data) throws IOException {
 		this.block = createBlockFromEndOfData(data, READ_BLOCK_SIZE);

spring-boot-tools/spring-boot-loader/src/main/java/org/springframework/boot/loader/jar/JarEntryData.java

@@ -97,9 +97,10 @@ public final class JarEntryData {
 	}
 
 	/**
-	 * @return the underlying {@link RandomAccessData} for this entry. Generally this
+	 * Return the underlying {@link RandomAccessData} for this entry. Generally this
 	 * method should not be called directly and instead data should be accessed via
 	 * {@link JarFile#getInputStream(ZipEntry)}.
+	 * @return the data
 	 * @throws IOException if the data cannot be read
 	 */
 	public RandomAccessData getData() throws IOException {
@@ -200,7 +201,7 @@ public final class JarEntryData {
 	 * @param source the source {@link JarFile}
 	 * @param inputStream the input stream to load data from
 	 * @return a {@link JarEntryData} or {@code null}
-	 * @throws IOException
+	 * @throws IOException in case of I/O errors
 	 */
 	static JarEntryData fromInputStream(JarFile source, InputStream inputStream)
 			throws IOException {

spring-boot-tools/spring-boot-loader/src/main/java/org/springframework/boot/loader/util/SystemPropertyUtils.java

@@ -38,17 +38,17 @@ import java.util.Set;
 public abstract class SystemPropertyUtils {
 
 	/**
-	 * Prefix for system property placeholders: "${"
+	 * Prefix for system property placeholders: "${".
 	 */
 	public static final String PLACEHOLDER_PREFIX = "${";
 
 	/**
-	 * Suffix for system property placeholders: "}"
+	 * Suffix for system property placeholders: "}".
 	 */
 	public static final String PLACEHOLDER_SUFFIX = "}";
 
 	/**
-	 * Value separator for system property placeholders: ":"
+	 * Value separator for system property placeholders: ":".
 	 */
 	public static final String VALUE_SEPARATOR = ":";
 
@@ -59,9 +59,9 @@ public abstract class SystemPropertyUtils {
 	 * system property values.
 	 * @param text the String to resolve
 	 * @return the resolved String
+	 * @throws IllegalArgumentException if there is an unresolvable placeholder
 	 * @see #PLACEHOLDER_PREFIX
 	 * @see #PLACEHOLDER_SUFFIX
-	 * @throws IllegalArgumentException if there is an unresolvable placeholder
 	 */
 	public static String resolvePlaceholders(String text) {
 		if (text == null) {
@@ -76,9 +76,9 @@ public abstract class SystemPropertyUtils {
 	 * @param properties a properties instance to use in addition to System
 	 * @param text the String to resolve
 	 * @return the resolved String
+	 * @throws IllegalArgumentException if there is an unresolvable placeholder
 	 * @see #PLACEHOLDER_PREFIX
 	 * @see #PLACEHOLDER_SUFFIX
-	 * @throws IllegalArgumentException if there is an unresolvable placeholder
 	 */
 	public static String resolvePlaceholders(Properties properties, String text) {
 		if (text == null) {