Support building against OpenJDK8

The OpenJDK8 javadoc parser is much more strict and raises
erorrs on marlformed html, incorrect parameter names and
incorrect throws declerations.

2014-01-23  Omair Majid  <[email protected]>

       * netx/net/sourceforge/jnlp/JNLPFile.java,
       * netx/net/sourceforge/jnlp/NetxPanel.java,
       * netx/net/sourceforge/jnlp/cache/CacheLRUWrapper.java,
       * netx/net/sourceforge/jnlp/cache/CacheUtil.java,
       * netx/net/sourceforge/jnlp/config/DeploymentConfiguration.java,
       * netx/net/sourceforge/jnlp/config/DirectoryValidator.java,
       * netx/net/sourceforge/jnlp/config/Setting.java,
       * netx/net/sourceforge/jnlp/controlpanel/AdvancedProxySettingsDialog.java,
       * netx/net/sourceforge/jnlp/runtime/JNLPClassLoader.java,
       * netx/net/sourceforge/jnlp/runtime/JNLPRuntime.java,
       * netx/net/sourceforge/jnlp/runtime/RhinoBasedPacEvaluator.java,
       * netx/net/sourceforge/jnlp/security/SecurityDialogs.java,
       * netx/net/sourceforge/jnlp/security/VariableX509TrustManager.java,
       * netx/net/sourceforge/jnlp/services/XSingleInstanceService.java,
       * netx/net/sourceforge/jnlp/util/FileUtils.java,
       * netx/net/sourceforge/jnlp/util/JarFile.java,
       * netx/net/sourceforge/nanoxml/XMLElement.java,
       * netx/net/sourceforge/nanoxml/XMLParseException.java,
       * plugin/icedteanp/java/sun/applet/PluginStreamHandler.java: Fix incorrect
       parameter names, throws declerations and malformed html in javadocs.

16 files changed, 25 insertions, 28 deletions

diff --git a/netx/net/sourceforge/jnlp/JNLPFile.java b/netx/net/sourceforge/jnlp/JNLPFile.java
index acf510f..338bc8f 100644
--- a/netx/net/sourceforge/jnlp/JNLPFile.java
+++ b/netx/net/sourceforge/jnlp/JNLPFile.java
@@ -199,7 +199,7 @@ public class JNLPFile {
      *
      * @param location the location of the JNLP file
      * @param version the version of the JNLP file
-     * @param strict whether to enforce the spec when
+     * @param settings the {@link ParserSettings} to use when parsing the {@code location}
      * @param policy the update policy
      * @throws IOException if an IO exception occurred
      * @throws ParseException if the JNLP file was invalid
@@ -264,7 +264,6 @@ public class JNLPFile {
     /**
      * Create a JNLPFile from an input stream.
      *
-     * @throws IOException if an IO exception occurred
      * @throws ParseException if the JNLP file was invalid
      */
     public JNLPFile(InputStream input, ParserSettings settings) throws ParseException {
@@ -277,8 +276,7 @@ public class JNLPFile {
      *
      * @param input input stream of JNLP file.
      * @param codebase codebase to use if not specified in JNLP file..
-     * @param strict whether to enforce the spec rules
-     * @throws IOException if an IO exception occurred
+     * @param settings the {@link ParserSettings} to use when parsing
      * @throws ParseException if the JNLP file was invalid
      */
     public JNLPFile(InputStream input, URL codebase, ParserSettings settings) throws ParseException {
@@ -665,9 +663,7 @@ public class JNLPFile {
      *
      * @param requested the local
      * @param available the available locales
-     * @param precision the depth with which to match locales. 1 checks only
-     * language, 2 checks language and country, 3 checks language, country and
-     * variant for matches. Passing 0 will always return true.
+     * @param matchLevel the detail with which to match locales.
      * @return true if requested matches any of available, or if
      * available is empty or null.
      */
diff --git a/netx/net/sourceforge/jnlp/NetxPanel.java b/netx/net/sourceforge/jnlp/NetxPanel.java
index 847adff..f6280d3 100644
--- a/netx/net/sourceforge/jnlp/NetxPanel.java
+++ b/netx/net/sourceforge/jnlp/NetxPanel.java
@@ -42,7 +42,7 @@ import sun.awt.SunToolkit;
  * This panel calls into netx to run an applet, and pipes the display
  * into a panel from the icedtea-web browser plugin.
  *
- * @author      Francis Kung <[email protected]>
+ * @author      Francis Kung &lt;[email protected]&gt;
  */
 public class NetxPanel extends AppletViewerPanel implements SplashController {
     private final PluginParameters parameters;
diff --git a/netx/net/sourceforge/jnlp/cache/CacheLRUWrapper.java b/netx/net/sourceforge/jnlp/cache/CacheLRUWrapper.java
index bbd0cd0..360f993 100644
--- a/netx/net/sourceforge/jnlp/cache/CacheLRUWrapper.java
+++ b/netx/net/sourceforge/jnlp/cache/CacheLRUWrapper.java
@@ -98,9 +98,6 @@ public enum CacheLRUWrapper {
     
     /**
      * Returns an instance of the policy.
-     * 
-     * @param propertiesFile
-     * @return
      */
     public static CacheLRUWrapper getInstance() {
         return INSTANCE;
diff --git a/netx/net/sourceforge/jnlp/cache/CacheUtil.java b/netx/net/sourceforge/jnlp/cache/CacheUtil.java
index f2bf0fa..2f77a0d 100644
--- a/netx/net/sourceforge/jnlp/cache/CacheUtil.java
+++ b/netx/net/sourceforge/jnlp/cache/CacheUtil.java
@@ -368,7 +368,7 @@ public class CacheUtil {
 
     /**
      * Returns the parent directory of the cached resource.
-     * @param path The path of the cached resource directory.
+     * @param filePath The path of the cached resource directory.
      */
     public static String getCacheParentDirectory(String filePath) {
         String path = filePath;
diff --git a/netx/net/sourceforge/jnlp/config/DeploymentConfiguration.java b/netx/net/sourceforge/jnlp/config/DeploymentConfiguration.java
index 43c8945..3441fee 100644
--- a/netx/net/sourceforge/jnlp/config/DeploymentConfiguration.java
+++ b/netx/net/sourceforge/jnlp/config/DeploymentConfiguration.java
@@ -247,7 +247,7 @@ public final class DeploymentConfiguration {
      * Initialize this deployment configuration by reading configuration files.
      * Generally, it will try to continue and ignore errors it finds (such as file not found).
      *
-     * @throws DeploymentException if it encounters a fatal error.
+     * @throws ConfigurationException if it encounters a fatal error.
      */
     public void load() throws ConfigurationException {
         load(true);
@@ -269,7 +269,7 @@ public final class DeploymentConfiguration {
      *
      * @param fixIssues If true, fix issues that are discovered when reading configuration by
      * resorting to the default values
-     * @throws DeploymentException if it encounters a fatal error.
+     * @throws ConfigurationException if it encounters a fatal error.
      */
     public void load(boolean fixIssues) throws ConfigurationException {
         // make sure no state leaks if security check fails later on
diff --git a/netx/net/sourceforge/jnlp/config/DirectoryValidator.java b/netx/net/sourceforge/jnlp/config/DirectoryValidator.java
index 3d526fd..8a410d7 100644
--- a/netx/net/sourceforge/jnlp/config/DirectoryValidator.java
+++ b/netx/net/sourceforge/jnlp/config/DirectoryValidator.java
@@ -216,12 +216,14 @@ public class DirectoryValidator {
     /**
      *  Creates DirectoryValidator to ensure directories read from
      *  user (if any - default otherwise ) settings via keys:
+     * <ul>
      * <li>KEY_USER_CACHE_DIR</li> 
      * <li>KEY_USER_PERSISTENCE_CACHE_DIR</li>
      * <li>KEY_SYSTEM_CACHE_DIR</li> 
      * <li>KEY_USER_LOG_DIR</li>
      * <li>KEY_USER_TMP_DIR</li> 
      * <li>KEY_USER_LOCKS_DIR</li>
+     * </ul>
      */
     public DirectoryValidator() {
         dirsToCheck = new ArrayList<File>(6);
diff --git a/netx/net/sourceforge/jnlp/config/Setting.java b/netx/net/sourceforge/jnlp/config/Setting.java
index 34faacc..a578ff6 100644
--- a/netx/net/sourceforge/jnlp/config/Setting.java
+++ b/netx/net/sourceforge/jnlp/config/Setting.java
@@ -67,7 +67,7 @@ public class Setting<T> {
      * @param defaultValue the default value of this setting. If this is not a
      * recognized setting, use null.
      * @param value the initial value of this setting
-     * @param source the origin of the value (a file, or perhaps "<internal>")
+     * @param source the origin of the value (a file, or perhaps "{@code <internal>}")
      */
     public Setting(String name, String description, boolean locked,
             ValueValidator validator, T defaultValue, T value, String source) {
diff --git a/netx/net/sourceforge/jnlp/controlpanel/AdvancedProxySettingsDialog.java b/netx/net/sourceforge/jnlp/controlpanel/AdvancedProxySettingsDialog.java
index 398bc15..3063718 100644
--- a/netx/net/sourceforge/jnlp/controlpanel/AdvancedProxySettingsDialog.java
+++ b/netx/net/sourceforge/jnlp/controlpanel/AdvancedProxySettingsDialog.java
@@ -37,7 +37,7 @@ import net.sourceforge.jnlp.util.ScreenFinder;
 /**
  * This dialog provides a means for user to edit more of the proxy settings.
  * 
- * @author Andrew Su <[email protected], [email protected]>
+ * @author Andrew Su &lt;[email protected], [email protected]&gt;
  * 
  */
 public class AdvancedProxySettingsDialog extends JDialog {
diff --git a/netx/net/sourceforge/jnlp/runtime/JNLPClassLoader.java b/netx/net/sourceforge/jnlp/runtime/JNLPClassLoader.java
index 5b2a8c5..f279474 100644
--- a/netx/net/sourceforge/jnlp/runtime/JNLPClassLoader.java
+++ b/netx/net/sourceforge/jnlp/runtime/JNLPClassLoader.java
@@ -796,7 +796,6 @@ public class JNLPClassLoader extends URLClassLoader {
      * 
      * @param jars Jars that are checked to see if they contain the main class
      * @param  name attribute to be found
-     * @throws LaunchException Thrown if the signed JNLP file, within the main jar, fails to be verified or does not match
      */
     public String checkForAttributeInJars(List<JARDesc> jars, Attributes.Name name) {
        
diff --git a/netx/net/sourceforge/jnlp/runtime/JNLPRuntime.java b/netx/net/sourceforge/jnlp/runtime/JNLPRuntime.java
index ac510ba..12bcfa8 100644
--- a/netx/net/sourceforge/jnlp/runtime/JNLPRuntime.java
+++ b/netx/net/sourceforge/jnlp/runtime/JNLPRuntime.java
@@ -684,7 +684,8 @@ public class JNLPRuntime {
     }
 
     /**
-     * Indicate that netx is running by creating the {@link JNLPRuntime#INSTANCE_FILE} and
+     * Indicate that netx is running by creating the file corresponding to 
+     * {@link DeploymentConfiguration#KEY_USER_NETX_RUNNING_FILE} and
      * acquiring a shared lock on it
      */
     public synchronized static void markNetxRunning() {
@@ -734,8 +735,8 @@ public class JNLPRuntime {
     }
 
     /**
-     * Indicate that netx is stopped by releasing the shared lock on
-     * {@link JNLPRuntime#INSTANCE_FILE}.
+     * Indicate that netx is stopped by releasing the shared lock on the file
+     * corresponding to {@link DeploymentConfiguration#KEY_USER_NETX_RUNNING_FILE}.
      */
     private static void markNetxStopped() {
         if (fileLock == null) {
diff --git a/netx/net/sourceforge/jnlp/runtime/RhinoBasedPacEvaluator.java b/netx/net/sourceforge/jnlp/runtime/RhinoBasedPacEvaluator.java
index eb4030b..a0f7c42 100644
--- a/netx/net/sourceforge/jnlp/runtime/RhinoBasedPacEvaluator.java
+++ b/netx/net/sourceforge/jnlp/runtime/RhinoBasedPacEvaluator.java
@@ -61,7 +61,7 @@ import org.mozilla.javascript.Scriptable;
  * Represents a Proxy Auto Config file. This object can be used to evaluate the
  * proxy file to find the proxy for a given url.
  *
- * @see "http://en.wikipedia.org/wiki/Proxy_auto-config#The_PAC_file"
+ * @see <a href="http://en.wikipedia.org/wiki/Proxy_auto-config#The_PAC_file">The PAC File</a>
  */
 public class RhinoBasedPacEvaluator implements PacEvaluator {
 
diff --git a/netx/net/sourceforge/jnlp/security/SecurityDialogs.java b/netx/net/sourceforge/jnlp/security/SecurityDialogs.java
index da70d79..5d0431c 100644
--- a/netx/net/sourceforge/jnlp/security/SecurityDialogs.java
+++ b/netx/net/sourceforge/jnlp/security/SecurityDialogs.java
@@ -240,7 +240,7 @@ public class SecurityDialogs {
 
     /**
      * FIXME This is unused. Remove it?
-     * @return (0, 1, 2) => (Yes, No, Cancel)
+     * @return (0, 1, 2) =&gt; (Yes, No, Cancel)
      */
     public static int showAppletWarning() {
 
diff --git a/netx/net/sourceforge/jnlp/security/VariableX509TrustManager.java b/netx/net/sourceforge/jnlp/security/VariableX509TrustManager.java
index b92f02c..826aa95 100644
--- a/netx/net/sourceforge/jnlp/security/VariableX509TrustManager.java
+++ b/netx/net/sourceforge/jnlp/security/VariableX509TrustManager.java
@@ -200,7 +200,7 @@ final public class VariableX509TrustManager {
      * @param authType The auth type algorithm
      * @param hostName The expected hostName that the server should have
      * @param socket The SSLSocket in use (may be null)
-     * @param ending The SSLEngine in use (may be null)
+     * @param engine The SSLEngine in use (may be null)
      */
     public synchronized void checkTrustServer(X509Certificate[] chain,
                              String authType, String hostName,
diff --git a/netx/net/sourceforge/jnlp/services/XSingleInstanceService.java b/netx/net/sourceforge/jnlp/services/XSingleInstanceService.java
index f82889e..8e23878 100644
--- a/netx/net/sourceforge/jnlp/services/XSingleInstanceService.java
+++ b/netx/net/sourceforge/jnlp/services/XSingleInstanceService.java
@@ -103,7 +103,7 @@ public class XSingleInstanceService implements ExtendedSingleInstanceService {
     /**
      * Initialize the new SingleInstanceService
      *
-     * @throws InstanceAlreadyExistsException if the instance already exists
+     * @throws InstanceExistsException if the instance already exists
      */
     public void initializeSingleInstance() {
         // this is called after the application has started. so safe to use
@@ -222,7 +222,7 @@ public class XSingleInstanceService implements ExtendedSingleInstanceService {
     /**
      * Add the specified SingleInstanceListener
      *
-     * @throws InstanceExistsException, which is likely to terminate the
+     * @throws InstanceExistsException which is likely to terminate the
      *         application but not guaranteed to
      */
     public void addSingleInstanceListener(SingleInstanceListener sil) {
diff --git a/netx/net/sourceforge/jnlp/util/FileUtils.java b/netx/net/sourceforge/jnlp/util/FileUtils.java
index f1ee124..e82671f 100644
--- a/netx/net/sourceforge/jnlp/util/FileUtils.java
+++ b/netx/net/sourceforge/jnlp/util/FileUtils.java
@@ -398,7 +398,8 @@ public final class FileUtils {
     /**
      * utility method which can read from any stream as one long String
      * 
-     * @param input stream
+     * @param is stream
+     * @param encoding the encoding to use to convert the bytes from the stream
      * @return stream as string
      * @throws IOException if connection can't be established or resource does not exist
      */
@@ -424,7 +425,7 @@ public final class FileUtils {
     /**
      * utility method which can read from any stream as one long String
      *
-     * @param input stream
+     * @param is stream
      * @return stream as string
      * @throws IOException if connection can't be established or resource does not exist
      */
diff --git a/netx/net/sourceforge/jnlp/util/JarFile.java b/netx/net/sourceforge/jnlp/util/JarFile.java
index f90cba3..72e6bf5 100644
--- a/netx/net/sourceforge/jnlp/util/JarFile.java
+++ b/netx/net/sourceforge/jnlp/util/JarFile.java
@@ -115,7 +115,8 @@ public class JarFile extends java.util.jar.JarFile implements Closeable{
      * So for our purposes we must insists on first record to be valid.
      *
      * @param file
-     * @throws IOException, InvalidJarHeaderException
+     * @throws IOException
+     * @throws InvalidJarHeaderException
      */
     public static void verifyZipHeader(File file) throws IOException {
         if (!JNLPRuntime.isIgnoreHeaders()) {