/hg/icedtea-web: Fixed javadoc warnings and errors to pass doclint
jvanek at icedtea.classpath.org
jvanek at icedtea.classpath.org
Thu Apr 16 17:35:15 UTC 2015
changeset 5837261a12aa in /hg/icedtea-web
details: http://icedtea.classpath.org/hg/icedtea-web?cmd=changeset;node=5837261a12aa
author: Jiri Vanek <jvanek at redhat.com>
date: Thu Apr 16 19:34:18 2015 +0200
Fixed javadoc warnings and errors to pass doclint
diffstat:
ChangeLog | 5 +
Makefile.am | 4 +-
launcher/launchers.in | 4 +-
netx/net/sourceforge/jnlp/AbstractLaunchHandler.java | 1 +
netx/net/sourceforge/jnlp/AppletDesc.java | 30 +-
netx/net/sourceforge/jnlp/ApplicationDesc.java | 9 +-
netx/net/sourceforge/jnlp/AssociationDesc.java | 8 +-
netx/net/sourceforge/jnlp/ExtensionDesc.java | 22 +-
netx/net/sourceforge/jnlp/IconDesc.java | 24 +-
netx/net/sourceforge/jnlp/InformationDesc.java | 56 +-
netx/net/sourceforge/jnlp/JARDesc.java | 14 +-
netx/net/sourceforge/jnlp/JNLPFile.java | 132 ++-
netx/net/sourceforge/jnlp/JNLPSplashScreen.java | 2 -
netx/net/sourceforge/jnlp/JREDesc.java | 28 +-
netx/net/sourceforge/jnlp/LaunchException.java | 44 +-
netx/net/sourceforge/jnlp/LaunchHandler.java | 3 +
netx/net/sourceforge/jnlp/Launcher.java | 38 +-
netx/net/sourceforge/jnlp/MalformedXMLParser.java | 9 +-
netx/net/sourceforge/jnlp/MenuDesc.java | 5 +-
netx/net/sourceforge/jnlp/NetxPanel.java | 2 +-
netx/net/sourceforge/jnlp/PackageDesc.java | 15 +-
netx/net/sourceforge/jnlp/ParseException.java | 5 +-
netx/net/sourceforge/jnlp/Parser.java | 288 +++++----
netx/net/sourceforge/jnlp/ParserSettings.java | 12 +-
netx/net/sourceforge/jnlp/PluginBridge.java | 38 +-
netx/net/sourceforge/jnlp/PropertyDesc.java | 5 +-
netx/net/sourceforge/jnlp/RelatedContentDesc.java | 10 +-
netx/net/sourceforge/jnlp/ResourcesDesc.java | 87 +-
netx/net/sourceforge/jnlp/SecurityDesc.java | 22 +-
netx/net/sourceforge/jnlp/ShortcutDesc.java | 10 +-
netx/net/sourceforge/jnlp/Version.java | 55 +-
netx/net/sourceforge/jnlp/XmlParser.java | 3 +-
netx/net/sourceforge/jnlp/cache/CacheDirectory.java | 6 +-
netx/net/sourceforge/jnlp/cache/CacheEntry.java | 1 +
netx/net/sourceforge/jnlp/cache/CacheLRUWrapper.java | 2 +-
netx/net/sourceforge/jnlp/cache/CacheUtil.java | 20 +-
netx/net/sourceforge/jnlp/cache/DefaultDownloadIndicator.java | 26 +-
netx/net/sourceforge/jnlp/cache/DownloadIndicator.java | 1 +
netx/net/sourceforge/jnlp/cache/NativeLibraryStorage.java | 73 +-
netx/net/sourceforge/jnlp/cache/Resource.java | 21 +-
netx/net/sourceforge/jnlp/cache/ResourceTracker.java | 12 +-
netx/net/sourceforge/jnlp/cache/ResourceUrlCreator.java | 12 +-
netx/net/sourceforge/jnlp/cache/UpdatePolicy.java | 8 +-
netx/net/sourceforge/jnlp/config/BasicValueValidators.java | 5 +-
netx/net/sourceforge/jnlp/config/Defaults.java | 1 +
netx/net/sourceforge/jnlp/config/DeploymentConfiguration.java | 1 +
netx/net/sourceforge/jnlp/config/DirectoryValidator.java | 11 +-
netx/net/sourceforge/jnlp/config/InfrastructureFileDescriptor.java | 12 +-
netx/net/sourceforge/jnlp/controlpanel/CachePane.java | 7 +-
netx/net/sourceforge/jnlp/controlpanel/CommandLine.java | 2 +
netx/net/sourceforge/jnlp/event/ApplicationEvent.java | 4 +-
netx/net/sourceforge/jnlp/event/ApplicationListener.java | 1 +
netx/net/sourceforge/jnlp/event/DownloadEvent.java | 8 +-
netx/net/sourceforge/jnlp/event/DownloadListener.java | 3 +
netx/net/sourceforge/jnlp/runtime/AppletEnvironment.java | 30 +-
netx/net/sourceforge/jnlp/runtime/AppletInstance.java | 25 +-
netx/net/sourceforge/jnlp/runtime/ApplicationInstance.java | 2 +-
netx/net/sourceforge/jnlp/runtime/Boot.java | 4 +-
netx/net/sourceforge/jnlp/runtime/JNLPClassLoader.java | 31 +-
netx/net/sourceforge/jnlp/runtime/JNLPProxySelector.java | 61 +-
netx/net/sourceforge/jnlp/runtime/JNLPRuntime.java | 41 +-
netx/net/sourceforge/jnlp/runtime/ManageJnlpResources.java | 4 +-
netx/net/sourceforge/jnlp/runtime/Translator.java | 8 +-
netx/net/sourceforge/jnlp/security/AppVerifier.java | 6 +-
netx/net/sourceforge/jnlp/security/CertVerifier.java | 21 +-
netx/net/sourceforge/jnlp/security/CertificateUtils.java | 33 +-
netx/net/sourceforge/jnlp/security/KeyStores.java | 22 +-
netx/net/sourceforge/jnlp/security/SecurityDialog.java | 5 +-
netx/net/sourceforge/jnlp/security/SecurityDialogs.java | 11 +-
netx/net/sourceforge/jnlp/security/SecurityUtil.java | 14 +-
netx/net/sourceforge/jnlp/security/VariableX509TrustManager.java | 79 +-
netx/net/sourceforge/jnlp/services/ServiceUtil.java | 36 +-
netx/net/sourceforge/jnlp/tools/JarCertVerifier.java | 45 +-
netx/net/sourceforge/jnlp/tools/KeyStoreUtil.java | 4 +
netx/net/sourceforge/jnlp/util/ClasspathMatcher.java | 18 +-
netx/net/sourceforge/jnlp/util/FileUtils.java | 33 +-
netx/net/sourceforge/jnlp/util/HttpUtils.java | 12 +-
netx/net/sourceforge/jnlp/util/ImageResources.java | 6 +-
netx/net/sourceforge/jnlp/util/PropertiesFile.java | 9 +-
netx/net/sourceforge/jnlp/util/StreamUtils.java | 3 +
netx/net/sourceforge/jnlp/util/UrlUtils.java | 20 +-
netx/net/sourceforge/jnlp/util/WeakList.java | 28 +-
netx/net/sourceforge/jnlp/util/XDesktopEntry.java | 11 +-
netx/net/sourceforge/nanoxml/XMLElement.java | 51 +-
netx/net/sourceforge/nanoxml/XMLParseException.java | 3 +-
plugin/icedteanp/java/netscape/javascript/JSException.java | 8 +
plugin/icedteanp/java/netscape/javascript/JSObject.java | 24 +-
plugin/icedteanp/java/netscape/security/PrivilegeManager.java | 4 +-
plugin/icedteanp/java/sun/applet/PluginAppletSecurityContext.java | 2 +-
plugin/icedteanp/java/sun/applet/PluginAppletViewer.java | 46 +-
plugin/icedteanp/java/sun/applet/PluginMain.java | 3 +-
plugin/icedteanp/java/sun/applet/PluginProxySelector.java | 9 +-
92 files changed, 1178 insertions(+), 821 deletions(-)
diffs (truncated from 6883 to 500 lines):
diff -r 40d37c2486a0 -r 5837261a12aa ChangeLog
--- a/ChangeLog Wed Apr 15 10:43:53 2015 +0200
+++ b/ChangeLog Thu Apr 16 19:34:18 2015 +0200
@@ -1,3 +1,8 @@
+2015-04-15 Jiri Vanek <jvanek at redhat.com>
+
+ Fixed javadoc warnings and errors to pass doclint
+ * /netx: nearly all files in main package get rid of doclint errors
+
2015-04-15 Jiri Vanek <jvanek at redhat.com>
jnlp-signing mechanism now uses general parser (and so also tagsoup if enabled)
diff -r 40d37c2486a0 -r 5837261a12aa Makefile.am
--- a/Makefile.am Wed Apr 15 10:43:53 2015 +0200
+++ b/Makefile.am Thu Apr 16 19:34:18 2015 +0200
@@ -648,11 +648,12 @@
stamps/netx-docs.stamp:
if ENABLE_DOCS
- $(SYSTEM_JDK_DIR)/bin/javadoc $(JAVADOC_MEM_OPTS) $(JAVADOC_OPTS) \
+ $(SYSTEM_JDK_DIR)/bin/javadoc $(JAVADOC_MEM_OPTS) $( _OPTS) \
-d ${abs_top_builddir}/docs/netx -sourcepath $(NETX_SRCDIR) \
-doctitle 'IcedTea-Web: NetX API Specification' \
-windowtitle 'IcedTea-Web: NetX ' \
-header '<strong>IcedTea-Web<br/>NetX</strong>' \
+ $(call composeclasspath, $(TAGSOUP_JAR) $(RHINO_JAR)) \
$(NETX_PKGS)
endif
mkdir -p stamps
@@ -670,6 +671,7 @@
-doctitle 'IcedTea-Web: Plugin API Specification' \
-windowtitle 'IcedTea-Web: Plugin ' \
-header '<strong>IcedTea-Web<br/>Plugin</strong>' \
+ $(call composeclasspath, $(TAGSOUP_JAR) $(RHINO_JAR)) \
$(PLUGIN_PKGS)
endif
endif
diff -r 40d37c2486a0 -r 5837261a12aa launcher/launchers.in
--- a/launcher/launchers.in Wed Apr 15 10:43:53 2015 +0200
+++ b/launcher/launchers.in Thu Apr 16 19:34:18 2015 +0200
@@ -7,7 +7,7 @@
BINARY_LOCATION=@BIN_LOCATION@
SPLASH_LOCATION=@JAVAWS_SPLASH_LOCATION@
PROGRAM_NAME=@PROGRAM_NAME@
-CP=@JRE@/lib/rt.jar
+CP=@JRE@/lib/rt.jar:@JRE@/lib/ext/jfxrt.jar
CONFIG_HOME=$XDG_CONFIG_HOME
if [ "x$CONFIG_HOME" = "x" ] ; then
@@ -27,7 +27,7 @@
if [ "x$CUSTOM_JRE" != "x" ] ; then
if [ -e "$CUSTOM_JRE" -a -e "$CUSTOM_JRE/bin/java" -a -e "$CUSTOM_JRE/lib/rt.jar" ] ; then
JAVA=$CUSTOM_JRE/bin/java
- CP=$CUSTOM_JRE/lib/rt.jar
+ CP=$CUSTOM_JRE/lib/rt.jar:$CUSTOM_JRE/lib/ext/jfxrt.jar
else
echo "Your custom JRE $CUSTOM_JRE read from deployment.properties under key $PROPERTY_NAME as $CUSTOM_JRE is not valid. Using default ($JAVA, $CP) in attempt to start. Please fix this."
fi
diff -r 40d37c2486a0 -r 5837261a12aa netx/net/sourceforge/jnlp/AbstractLaunchHandler.java
--- a/netx/net/sourceforge/jnlp/AbstractLaunchHandler.java Wed Apr 15 10:43:53 2015 +0200
+++ b/netx/net/sourceforge/jnlp/AbstractLaunchHandler.java Thu Apr 16 19:34:18 2015 +0200
@@ -50,6 +50,7 @@
/**
* Print a message
+ * @param ex exception to be printed out
*/
protected void printMessage(LaunchException ex) {
StringBuilder result = new StringBuilder();
diff -r 40d37c2486a0 -r 5837261a12aa netx/net/sourceforge/jnlp/AppletDesc.java
--- a/netx/net/sourceforge/jnlp/AppletDesc.java Wed Apr 15 10:43:53 2015 +0200
+++ b/netx/net/sourceforge/jnlp/AppletDesc.java Thu Apr 16 19:34:18 2015 +0200
@@ -28,22 +28,22 @@
public class AppletDesc implements LaunchDesc {
/** the applet name */
- private String name;
+ private final String name;
/** the main class name and package */
- private String mainClass;
+ private final String mainClass;
/** the document base */
- private URL documentBase;
+ private final URL documentBase;
/** the width */
- private int width;
+ private final int width;
/** the height */
- private int height;
+ private final int height;
/** the parameters */
- private Map<String, String> parameters;
+ private final Map<String, String> parameters;
/**
* Create an Applet descriptor.
@@ -62,18 +62,18 @@
this.documentBase = documentBase;
this.width = width;
this.height = height;
- this.parameters = new HashMap<String, String>(parameters);
+ this.parameters = new HashMap<>(parameters);
}
/**
- * Returns the applet name
+ * @return the applet name
*/
public String getName() {
return name;
}
/**
- * Returns the main class name in the dot-separated form (eg: foo.bar.Baz)
+ * @return the main class name in the dot-separated form (eg: foo.bar.Baz)
*/
@Override
public String getMainClass() {
@@ -81,31 +81,31 @@
}
/**
- * Returns the document base
+ * @return the document base
*/
public URL getDocumentBase() {
return documentBase;
}
/**
- * Returns the width
+ * @return the width
*/
public int getWidth() {
return width;
}
/**
- * Returns the height
+ * @return the height
*/
public int getHeight() {
return height;
}
/**
- * Returns the applet parameters
+ * @return the applet parameters
*/
public Map<String, String> getParameters() {
- return new HashMap<String, String>(parameters);
+ return new HashMap<>(parameters);
}
/**
@@ -113,6 +113,8 @@
* exists then it is overwritten with the new value. Adding a
* parameter will have no effect on already-running applets
* launched from this JNLP file.
+ * @param name key of value
+ * @param value value to be added
*/
public void addParameter(String name, String value) {
parameters.put(name, value);
diff -r 40d37c2486a0 -r 5837261a12aa netx/net/sourceforge/jnlp/ApplicationDesc.java
--- a/netx/net/sourceforge/jnlp/ApplicationDesc.java Wed Apr 15 10:43:53 2015 +0200
+++ b/netx/net/sourceforge/jnlp/ApplicationDesc.java Thu Apr 16 19:34:18 2015 +0200
@@ -27,7 +27,7 @@
public class ApplicationDesc implements LaunchDesc {
/** the main class name and package */
- private String mainClass;
+ private final String mainClass;
/** the arguments */
private String arguments[];
@@ -44,7 +44,7 @@
}
/**
- * Returns the main class name
+ * @return the main class name
*/
@Override
public String getMainClass() {
@@ -52,7 +52,7 @@
}
/**
- * Returns the arguments
+ * @return the arguments
*/
public String[] getArguments() {
return arguments.clone();
@@ -60,9 +60,10 @@
/**
* Add an argument to the end of the arguments.
+ * @param arg argument of command
*/
public void addArgument(String arg) {
- List<String> l = new ArrayList<String>(Arrays.asList(arguments));
+ List<String> l = new ArrayList<>(Arrays.asList(arguments));
l.add(arg);
arguments = l.toArray(arguments);
diff -r 40d37c2486a0 -r 5837261a12aa netx/net/sourceforge/jnlp/AssociationDesc.java
--- a/netx/net/sourceforge/jnlp/AssociationDesc.java Wed Apr 15 10:43:53 2015 +0200
+++ b/netx/net/sourceforge/jnlp/AssociationDesc.java Thu Apr 16 19:34:18 2015 +0200
@@ -19,10 +19,10 @@
public final class AssociationDesc {
/** the extensions this application wants to register with */
- private String[] extensions;
+ private final String[] extensions;
/** the mime type for the association */
- private String mimeType;
+ private final String mimeType;
public AssociationDesc(String mimeType, String[] extensions) throws ParseException {
checkMimeType(mimeType);
@@ -31,14 +31,14 @@
}
/**
- * Return the extensions for this association
+ * @return the extensions for this association
*/
public String[] getExtensions() {
return extensions;
}
/**
- * Return the mimetype for this association
+ * @return the mimetype for this association
*/
public String getMimeType() {
return mimeType;
diff -r 40d37c2486a0 -r 5837261a12aa netx/net/sourceforge/jnlp/ExtensionDesc.java
--- a/netx/net/sourceforge/jnlp/ExtensionDesc.java Wed Apr 15 10:43:53 2015 +0200
+++ b/netx/net/sourceforge/jnlp/ExtensionDesc.java Thu Apr 16 19:34:18 2015 +0200
@@ -22,7 +22,6 @@
import java.net.*;
import java.util.*;
-import net.sourceforge.jnlp.runtime.JNLPRuntime;
import net.sourceforge.jnlp.util.logging.OutputController;
/**
@@ -34,22 +33,22 @@
public class ExtensionDesc {
/** the extension name */
- private String name;
+ private final String name;
/** the required extension version */
- private Version version;
+ private final Version version;
/** the location of the extension JNLP file */
- private URL location;
+ private final URL location;
/** the JNLPFile the extension refers to */
private JNLPFile file;
/** map from ext-part to local part */
- private Map<String, String> extToPart = new HashMap<String, String>();
+ private final Map<String, String> extToPart = new HashMap<>();
/** eager ext parts */
- private List<String> eagerExtParts = new ArrayList<String>();
+ private final List<String> eagerExtParts = new ArrayList<>();
/**
* Create an extention descriptor.
@@ -82,7 +81,8 @@
}
/**
- * Returns the parts in the extension JNLP file mapped to the
+ * @param thisPart unimplemented
+ * @return the parts in the extension JNLP file mapped to the
* part of the main file.
*/
public String[] getExtensionParts(String thisPart) {
@@ -91,21 +91,21 @@
}
/**
- * Returns the name of the extension.
+ * @return the name of the extension.
*/
public String getName() {
return name;
}
/**
- * Returns the required version of the extension JNLP file.
+ * @return the required version of the extension JNLP file.
*/
public Version getVersion() {
return version;
}
/**
- * Returns the location of the extension JNLP file.
+ * @return the location of the extension JNLP file.
*/
public URL getLocation() {
return location;
@@ -133,7 +133,7 @@
}
/**
- * Returns a JNLPFile for the extension, or null if the JNLP
+ * @return a JNLPFile for the extension, or null if the JNLP
* file has not been resolved.
*/
public JNLPFile getJNLPFile() {
diff -r 40d37c2486a0 -r 5837261a12aa netx/net/sourceforge/jnlp/IconDesc.java
--- a/netx/net/sourceforge/jnlp/IconDesc.java Wed Apr 15 10:43:53 2015 +0200
+++ b/netx/net/sourceforge/jnlp/IconDesc.java Thu Apr 16 19:34:18 2015 +0200
@@ -45,22 +45,22 @@
public static final Object SHORTCUT = "shortcut";
/** the location of the icon */
- private URL location;
+ private final URL location;
/** the type of icon*/
- private Object kind;
+ private final Object kind;
/** the width, or -1 if unknown*/
- private int width;
+ private final int width;
/** the height, or -1 if unknown*/
- private int height;
+ private final int height;
/** the depth, or -1 if unknown*/
- private int depth;
+ private final int depth;
/** the size, or -1 if unknown*/
- private int size;
+ private final int size;
/**
* Creates an icon descriptor with the specified information.
@@ -82,21 +82,21 @@
}
/**
- * Returns the location of the icon.
+ * @return the location of the icon.
*/
public URL getLocation() {
return location;
}
/**
- * Returns the icon type.
+ * @return the icon type.
*/
public Object getKind() {
return kind;
}
/**
- * Returns the icon width or -1 if not specified in the
+ * @return the icon width or -1 if not specified in the
* JNLPFile.
*/
public int getWidth() {
@@ -104,7 +104,7 @@
}
/**
- * Returns the icon height or -1 if not specified in the
+ * @return the icon height or -1 if not specified in the
* JNLPFile.
*/
public int getHeight() {
@@ -112,14 +112,14 @@
}
/**
- * Returns the icon size or -1 if not specified in the JNLPFile.
+ * @return the icon size or -1 if not specified in the JNLPFile.
*/
public int getSize() {
return size;
}
/**
- * Returns the icon depth or -1 if not specified in the
+ * @return the icon depth or -1 if not specified in the
* JNLPFile.
*/
public int getDepth() {
diff -r 40d37c2486a0 -r 5837261a12aa netx/net/sourceforge/jnlp/InformationDesc.java
--- a/netx/net/sourceforge/jnlp/InformationDesc.java Wed Apr 15 10:43:53 2015 +0200
+++ b/netx/net/sourceforge/jnlp/InformationDesc.java Thu Apr 16 19:34:18 2015 +0200
@@ -57,6 +57,7 @@
* Create an information element object.
*
* @param locales the locales the information is for
+ * @param strict whether parser was strict
*/
public InformationDesc(Locale locales[], boolean strict) {
this.locales = locales;
@@ -68,28 +69,28 @@
}
/**
- * Returns the application's title.
+ * @return the application's title.
*/
public String getTitle() {
return (String) getItem("title");
}
/**
- * Returns the application's vendor.
+ * @return the application's vendor.
*/
public String getVendor() {
return (String) getItem("vendor");
}
/**
- * Returns the application's homepage.
+ * @return the application's homepage.
*/
public URL getHomepage() {
return (URL) getItem("homepage");
}
/**
- * Returns the default description for the application.
+ * @return the default description for the application.
*/
public String getDescription() {
String result = getDescription(DEFAULT);
@@ -106,7 +107,7 @@
}
/**
- * Returns the application's description of the specified type.
+ * @return the application's description of the specified type.
*
* @param kind one of Information.SHORT, Information.ONE_LINE,
* Information.TOOLTIP, Information.DEFAULT
@@ -120,7 +121,7 @@
}
/**
- * Returns the application's description of the specified type.
+ * @return the application's description of the specified type.
*
* @param kind one of Information.SHORT, Information.ONE_LINE,
* Information.TOOLTIP, Information.DEFAULT
@@ -160,15 +161,14 @@
return null;
IconDesc best = null;
- for (int i = 0; i < icons.length; i++) {
- if (icons[i].getWidth() >= width &&
- icons[i].getHeight() >= height) {
- if (best == null)
- best = icons[i];
-
- if (icons[i].getWidth() <= best.getWidth() && // Use <= so last specified of
- icons[i].getHeight() <= best.getHeight()) // equivalent icons is chosen.
- best = icons[i];
+ for (IconDesc icon : icons) {
+ if (icon.getWidth() >= width && icon.getHeight() >= height) {
+ if (best == null) {
+ best = icon;
+ }
+ if (icon.getWidth() <= best.getWidth() && icon.getHeight() <= best.getHeight()) {
+ best = icon;
+ }
}
}
@@ -181,14 +181,14 @@
}
/**
More information about the distro-pkg-dev
mailing list