Polish Javadoc

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

@@ -222,7 +222,7 @@ public class JarWriter {
 	 * delegate to this one.
 	 * @param entry the entry to write
 	 * @param entryWriter the entry writer or {@code null} if there is no content
-	 * @throws IOException
+	 * @throws IOException in case of I/O errors
 	 */
 	private void writeEntry(JarEntry entry, EntryWriter entryWriter) throws IOException {
 		String parent = entry.getName();
@@ -251,9 +251,9 @@ public class JarWriter {
 	private interface EntryWriter {
 
 		/**
-		 * Write entry data to the specified output stream
+		 * Write entry data to the specified output stream.
 		 * @param outputStream the destination for the data
-		 * @throws IOException
+		 * @throws IOException in case of I/O errors
 		 */
 		void write(OutputStream outputStream) throws IOException;
 
@@ -338,7 +338,7 @@ public class JarWriter {
 	}
 
 	/**
-	 * Data holder for CRC and Size
+	 * Data holder for CRC and Size.
 	 */
 	private static class CrcAndSize {
 

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

@@ -29,7 +29,7 @@ import java.net.URLClassLoader;
 abstract class JvmUtils {
 
 	/**
-	 * Various search locations for tools, including the odd Java 6 OSX jar
+	 * Various search locations for tools, including the odd Java 6 OSX jar.
 	 */
 	private static final String[] TOOLS_LOCATIONS = { "lib/tools.jar",
 			"../lib/tools.jar", "../Classes/classes.jar" };

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

@@ -151,7 +151,7 @@ public final class Layouts {
 	}
 
 	/**
-	 * Module layout (designed to be used as a "plug-in")
+	 * Module layout (designed to be used as a "plug-in").
 	 */
 	public static class Module implements Layout {
 

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

@@ -70,29 +70,33 @@ public class Library {
 	}
 
 	/**
-	 * @return the name of file as it should be written
+	 * Return the name of file as it should be written.
+	 * @return then name.
 	 */
 	public String getName() {
 		return this.name;
 	}
 
 	/**
-	 * @return the library file
+	 * Return the library file.
+	 * @return the file
 	 */
 	public File getFile() {
 		return this.file;
 	}
 
 	/**
-	 * @return the scope of the library
+	 * Return the scope of the library.
+	 * @return the scope
 	 */
 	public LibraryScope getScope() {
 		return this.scope;
 	}
 
 	/**
-	 * @return if the file cannot be used directly as a nested jar and needs to be
+	 * Return if the file cannot be used directly as a nested jar and needs to be
 	 * unpacked.
+	 * @return if unpack is required
 	 */
 	public boolean isUnpackRequired() {
 		return this.unpackRequired;

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

@@ -102,10 +102,11 @@ public abstract class MainClassFinder {
 	/**
 	 * Perform the given callback operation on all main classes from the given root
 	 * folder.
+	 * @param <T> the result type
 	 * @param rootFolder the root folder
 	 * @param callback the callback
 	 * @return the first callback result or {@code null}
-	 * @throws IOException
+	 * @throws IOException in case of I/O errors
 	 */
 	static <T> T doWithMainClasses(File rootFolder, ClassNameCallback<T> callback)
 			throws IOException {
@@ -190,11 +191,12 @@ public abstract class MainClassFinder {
 
 	/**
 	 * Perform the given callback operation on all main classes from the given jar.
+	 * @param <T> the result type
 	 * @param jarFile the jar file to search
 	 * @param classesLocation the location within the jar containing classes
 	 * @param callback the callback
 	 * @return the first callback result or {@code null}
-	 * @throws IOException
+	 * @throws IOException in case of I/O errors
 	 */
 	static <T> T doWithMainClasses(JarFile jarFile, String classesLocation,
 			ClassNameCallback<T> callback) throws IOException {
@@ -316,7 +318,7 @@ public abstract class MainClassFinder {
 	public interface ClassNameCallback<T> {
 
 		/**
-		 * Handle the specified class name
+		 * Handle the specified class name.
 		 * @param className the class name
 		 * @return a non-null value if processing should end or {@code null} to continue
 		 */

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

@@ -90,7 +90,7 @@ public class Repackager {
 	}
 
 	/**
-	 * Repackage the source file so that it can be run using '{@literal java -jar}'
+	 * Repackage the source file so that it can be run using '{@literal java -jar}'.
 	 * @param libraries the libraries required to run the archive
 	 * @throws IOException if the file cannot be repackaged
 	 */
@@ -100,7 +100,7 @@ public class Repackager {
 
 	/**
 	 * Repackage to the given destination so that it can be launched using '
-	 * {@literal java -jar}'
+	 * {@literal java -jar}'.
 	 * @param destination the destination file (may be the same as the source)
 	 * @param libraries the libraries required to run the archive
 	 * @throws IOException if the file cannot be repackaged
@@ -111,7 +111,7 @@ public class Repackager {
 
 	/**
 	 * Repackage to the given destination so that it can be launched using '
-	 * {@literal java -jar}'
+	 * {@literal java -jar}'.
 	 * @param destination the destination file (may be the same as the source)
 	 * @param libraries the libraries required to run the archive
 	 * @param launchScript an optional launch script prepended to the front of the jar

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

@@ -155,23 +155,23 @@ public class RunProcess {
 	}
 
 	/**
-	 * @return the running process or {@code null}
+	 * Return the running process.
+	 * @return the process or {@code null}
 	 */
 	public Process getRunningProcess() {
 		return this.process;
 	}
 
 	/**
-	 * @return {@code true} if the process was stopped.
+	 * Return if the process was stopped.
+	 * @return {@code true} if stopped
 	 */
 	public boolean handleSigInt() {
-
 		// if the process has just ended, probably due to this SIGINT, consider handled.
 		if (hasJustEnded()) {
 			return true;
 		}
 		return doKill();
-
 	}
 
 	/**

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

@@ -34,7 +34,7 @@ public final class SignalUtils {
 	}
 
 	/**
-	 * Handle {@literal INT} signals by calling the specified {@link Runnable}
+	 * Handle {@literal INT} signals by calling the specified {@link Runnable}.
 	 * @param runnable the runnable to call on SIGINT.
 	 */
 	public static void attachSignalHandler(final Runnable runnable) {