Polish Javadoc

Update Javadoc to add missing @return and @param elements.
This commit is contained in:
Phillip Webb
2015-02-03 11:34:27 -08:00
parent e489ab9b29
commit 8e398dc6a7
40 changed files with 131 additions and 27 deletions

View File

@@ -41,11 +41,13 @@ public interface Layout {
/**
* Returns the location of classes within the archive.
* @return the classes location
*/
String getClassesLocation();
/**
* Returns if loader classes should be included to make the archive executable.
* @return if the layout is executable
*/
boolean isExecutable();

View File

@@ -192,6 +192,7 @@ public abstract class MainClassFinder {
* Perform the given callback operation on all main classes from the given jar.
* @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
*/
@@ -310,6 +311,7 @@ public abstract class MainClassFinder {
/**
* Callback interface used to receive class names.
* @param <T> the result type
*/
public static interface ClassNameCallback<T> {