1 files changed, 19 insertions, 23 deletions

diff --git a/jetty-osgi/jetty-osgi-boot/src/main/java/org/eclipse/jetty/osgi/boot/utils/BundleFileLocatorHelper.java b/jetty-osgi/jetty-osgi-boot/src/main/java/org/eclipse/jetty/osgi/boot/utils/BundleFileLocatorHelper.java
index 13e419b786..8371dda91c 100644
--- a/jetty-osgi/jetty-osgi-boot/src/main/java/org/eclipse/jetty/osgi/boot/utils/BundleFileLocatorHelper.java
+++ b/jetty-osgi/jetty-osgi-boot/src/main/java/org/eclipse/jetty/osgi/boot/utils/BundleFileLocatorHelper.java
@@ -28,12 +28,9 @@ import org.osgi.framework.Bundle;
 
 /**
  * BundleFileLocatorHelper
- * 
- * 
+ * <p> 
  * From a bundle to its location on the filesystem. Assumes the bundle is not a
  * jar.
- * 
- * @author hmalphettes
  */
 public interface BundleFileLocatorHelper
 {
@@ -50,21 +47,20 @@ public interface BundleFileLocatorHelper
      * other situations.
      * <p>
      * Currently only works with bundles that are not jar.
-     * </p>
      * 
      * @param bundle The bundle
      * @return Its installation location as a file.
-     * @throws Exception
+     * @throws Exception if unable to get the install location
      */
     public File getBundleInstallLocation(Bundle bundle) throws Exception;
 
     /**
      * Locate a file inside a bundle.
      * 
-     * @param bundle
-     * @param path
-     * @return file object
-     * @throws Exception
+     * @param bundle the bundle
+     * @param path the path
+     * @return file the file object
+     * @throws Exception if unable to get the file
      */
     public File getFileInBundle(Bundle bundle, String path) throws Exception;
 
@@ -76,11 +72,11 @@ public interface BundleFileLocatorHelper
      * files inside jars alone. In fact we only support the second situation for
      * development purpose where the bundle was imported in pde and the classes
      * kept in a jar.
-     * </p>
      * 
-     * @param bundle
+     * @param bundle the bundle
      * @return The jar(s) file that is either the bundle itself, either the jars
      *         embedded inside it.
+     * @throws Exception if unable to locate the jars
      */
     public File[] locateJarsInsideBundle(Bundle bundle) throws Exception;
 
@@ -88,37 +84,37 @@ public interface BundleFileLocatorHelper
      * Helper method equivalent to Bundle#getEntry(String entryPath) except that
      * it searches for entries in the fragments by using the findEntries method.
      * 
-     * @param bundle
-     * @param entryPath
+     * @param bundle the bundle
+     * @param entryPath the entry path
      * @return null or all the entries found for that path.
      */
     public Enumeration<URL> findEntries(Bundle bundle, String entryPath);
     
     /**
-     * Only useful for equinox: on felix we get the file:// or jar:// url
+     * Only useful for equinox: on felix we get the <code>file://</code> or <code>jar://</code> url
      * already. Other OSGi implementations have not been tested
      * <p>
-     * Get a URL to the bundle entry that uses a common protocol (i.e. file:
-     * jar: or http: etc.).
-     * </p>
+     * Get a URL to the bundle entry that uses a common protocol (i.e. <code>file:</code>
+     * <code>jar:</code> or <code>http:</code> etc.).
      * 
+     * @param url the url 
      * @return a URL to the bundle entry that uses a common protocol
+     * @throws Exception if unable to get the local url
      */
     public URL getLocalURL(URL url) throws Exception;
     
     /**
-     * Only useful for equinox: on felix we get the file:// url already. Other
+     * Only useful for equinox: on felix we get the <code>file://</code> url already. Other
      * OSGi implementations have not been tested
      * <p>
-     * Get a URL to the content of the bundle entry that uses the file:
+     * Get a URL to the content of the bundle entry that uses the <code>file:</code>
      * protocol. The content of the bundle entry may be downloaded or extracted
      * to the local file system in order to create a file: URL.
      * 
+     * @param url the url 
      * @return a URL to the content of the bundle entry that uses the file:
      *         protocol
-     *         </p>
-     * @throws IOException 
-     * @throws Exception 
+     * @throws Exception if unable to get the file url
      */
     public URL getFileURL(URL url) throws Exception;