Fix Javadoc warnings.

2010-12-07  Andrew John Hughes  <[email protected]>

	* netx/net/sourceforge/jnlp/InformationDesc.java,
	(InformationDesc(JNLPFile,Locale)): Correct @param tag.
	* netx/net/sourceforge/jnlp/JARDesc.java:
	(JARDesc(URL,Version,String,boolean,boolean,boolean,boolean)):
	Correct typo and add missing @param tag for cacheable.
	* netx/net/sourceforge/jnlp/JREDesc.java:
	(JREDesc(Version,URL,String,String,String,List)): Correct typo
	in @param tag.
	* netx/net/sourceforge/jnlp/Launcher.java:
	(Launcher(boolean)): Correct broken @param tag.
	* netx/net/sourceforge/jnlp/cache/ResourceTracker.java:
	(addDownloadListener(DownloadListener)): Remove broken @param tags.
	Add correct one.
	(removeDownloadListener(DownloadListener)): Add missing @param tag.
	* netx/net/sourceforge/jnlp/security/KeyStores.java:
	(getKeyStoreLocation(Level,Type)): Add content to @param and @return tags.
	(toTranslatableString(Level,Type)): Likewise.
	* netx/net/sourceforge/jnlp/security/PasswordAuthenticationDialog.java:
	(askUser(String,int,String,String)): Correct typo in @param tag.
	* netx/net/sourceforge/jnlp/security/SecurityDialogPanel.java:
	(createSetValueListener(SecurityWarningDialog,int)): Add content to @return tag.
	* netx/net/sourceforge/jnlp/security/SecurityWarningDialog.java:
	(showCertInfoDialog(CertVerifier,SecurityWarningDialog)): Remove broken
	@param tag and add correct ones.
	(showSingleCertInfoDialog(X509Certificate,JDialog)): Add content to @param tags.
	* netx/net/sourceforge/jnlp/tools/CharacterEncoder.java:
	Remove broken @see tags from import from OpenJDK.
	* netx/net/sourceforge/jnlp/util/FileUtils.java:
	Fix bad whitespace.
	(sanitizeFileName(String)): Fix @param tag.
	* netx/net/sourceforge/nanoxml/XMLElement.java:
	Fix example in class documentation.
	* plugin/icedteanp/java/sun/applet/PluginAppletViewer.java,
	(waitForAppletInit(NetxPanel)): Fix @param tag.

4 files changed, 13 insertions, 11 deletions

diff --git a/netx/net/sourceforge/jnlp/security/KeyStores.java b/netx/net/sourceforge/jnlp/security/KeyStores.java
index cfabb20..fda324a 100644
--- a/netx/net/sourceforge/jnlp/security/KeyStores.java
+++ b/netx/net/sourceforge/jnlp/security/KeyStores.java
@@ -220,9 +220,10 @@ public final class KeyStores {
 
     /**
      * Returns the location of a KeyStore corresponding to the given level and type.
-     * @param level
-     * @param type
-     * @return
+     *
+     * @param level the specified level of the key store to be returned.
+     * @param type the specified type of the key store to be returned.
+     * @return the location of the key store.
      */
     public static final String getKeyStoreLocation(Level level, Type type) {
         String configKey = null;
@@ -280,9 +281,9 @@ public final class KeyStores {
      * concatenating a level and type, converting everything to Title Case and
      * removing the _'s. (USER,CA_CERTS) becomes UserCaCerts.
      *
-     * @param level
-     * @param type
-     * @return
+     * @param level the level of the key store.
+     * @param type the type of the key store.
+     * @return the translation key.
      */
     public static final String toTranslatableString(Level level, Type type) {
         StringBuilder response = new StringBuilder();
diff --git a/netx/net/sourceforge/jnlp/security/PasswordAuthenticationDialog.java b/netx/net/sourceforge/jnlp/security/PasswordAuthenticationDialog.java
index b05debe..a83506e 100644
--- a/netx/net/sourceforge/jnlp/security/PasswordAuthenticationDialog.java
+++ b/netx/net/sourceforge/jnlp/security/PasswordAuthenticationDialog.java
@@ -184,7 +184,7 @@ public class PasswordAuthenticationDialog extends JDialog {
     /**
      * Present a dialog to the user asking them for authentication information
      *
-     * @param hostThe host for with authentication is needed
+     * @param host The host for with authentication is needed
      * @param port The port being accessed
      * @param prompt The prompt (realm) as presented by the server
      * @param type The type of server (proxy/web)
diff --git a/netx/net/sourceforge/jnlp/security/SecurityDialogPanel.java b/netx/net/sourceforge/jnlp/security/SecurityDialogPanel.java
index 23109a8..8ffbbc1 100644
--- a/netx/net/sourceforge/jnlp/security/SecurityDialogPanel.java
+++ b/netx/net/sourceforge/jnlp/security/SecurityDialogPanel.java
@@ -78,7 +78,7 @@ public abstract class SecurityDialogPanel extends JPanel {
      * is invoked, it will set the value of the {@link SecurityWarningDialog} and then dispossed.
      *
      * @param buttonIndex the index of the button. By convention 0 = Yes. 1 = No, 2 = Cancel
-     * @return
+     * @return the ActionListener instance.
      */
     protected ActionListener createSetValueListener(SecurityWarningDialog dialog, int buttonIndex) {
         return new SetValueHandler(dialog, buttonIndex);
diff --git a/netx/net/sourceforge/jnlp/security/SecurityWarningDialog.java b/netx/net/sourceforge/jnlp/security/SecurityWarningDialog.java
index 60b13f0..2bf829f 100644
--- a/netx/net/sourceforge/jnlp/security/SecurityWarningDialog.java
+++ b/netx/net/sourceforge/jnlp/security/SecurityWarningDialog.java
@@ -175,7 +175,8 @@ public class SecurityWarningDialog extends JDialog {
     /**
      * Displays CertPath information in a readable table format.
      *
-     * @param certs the certificates used in signing.
+     * @param jarSigner the JarSigner used to verify this application
+     * @param parent the parent option pane
      */
     public static void showCertInfoDialog(CertVerifier jarSigner,
                 SecurityWarningDialog parent) {
@@ -190,8 +191,8 @@ public class SecurityWarningDialog extends JDialog {
     /**
      * Displays a single certificate's information.
      *
-     * @param c
-     * @param optionPane
+     * @param c the X509 certificate.
+     * @param parent the parent pane.
      */
     public static void showSingleCertInfoDialog(X509Certificate c,
                         JDialog parent) {