[icedtea-web] RFC: More javadoc fixes for Java 8
Omair Majid
omajid at redhat.com
Sat May 10 00:14:16 UTC 2014
Hi,
I recently tried compiling icedtea-web with java 8 and ran into more
javadoc issues. Apparently, self-enclosing tags (<br/>) are now not
allowed either.
The attached patch fixes the issues.
Thanks,
Omair
--
PGP Key: 66484681 (http://pgp.mit.edu/)
Fingerprint = F072 555B 0A17 3957 4E95 0056 F286 F14F 6648 4681
-------------- next part --------------
diff --git a/netx/net/sourceforge/jnlp/JNLPFile.java b/netx/net/sourceforge/jnlp/JNLPFile.java
--- a/netx/net/sourceforge/jnlp/JNLPFile.java
+++ b/netx/net/sourceforge/jnlp/JNLPFile.java
@@ -267,7 +267,6 @@
/**
* 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 {
@@ -281,7 +280,6 @@
* @param input input stream of JNLP file.
* @param codebase codebase to use if not specified in JNLP file..
* @param settings the {@link ParserSettings} to use when parsing
- * @throws IOException if an IO exception occurred
* @throws ParseException if the JNLP file was invalid
*/
public JNLPFile(InputStream input, URL codebase, ParserSettings settings) throws ParseException {
diff --git a/netx/net/sourceforge/jnlp/SecurityDesc.java b/netx/net/sourceforge/jnlp/SecurityDesc.java
--- a/netx/net/sourceforge/jnlp/SecurityDesc.java
+++ b/netx/net/sourceforge/jnlp/SecurityDesc.java
@@ -90,7 +90,7 @@
* The HTML permission level corresponding to the given String. If null is given, null comes
* back. If there is no permission level that can be granted in HTML matching the given String,
* null is also returned.
- * @param jnlpString the JNLP permission String
+ * @param htmlString the JNLP permission String
* @return the matching RequestedPermissionLevel
*/
public RequestedPermissionLevel fromHtmlString(final String htmlString) {
diff --git a/netx/net/sourceforge/jnlp/util/FileUtils.java b/netx/net/sourceforge/jnlp/util/FileUtils.java
--- a/netx/net/sourceforge/jnlp/util/FileUtils.java
+++ b/netx/net/sourceforge/jnlp/util/FileUtils.java
@@ -394,7 +394,6 @@
/**
* Show a dialog informing the user that the file could not be opened
* @param frame a {@link JFrame} to act as parent to this dialog
- * @param filePath a {@link String} representing the path to the file we failed to open
* @param message a {@link String} giving the specific reason the file could not be opened
*/
public static void showCouldNotOpenDialog(final Component frame, final String message) {
diff --git a/netx/net/sourceforge/nanoxml/XMLElement.java b/netx/net/sourceforge/nanoxml/XMLElement.java
--- a/netx/net/sourceforge/nanoxml/XMLElement.java
+++ b/netx/net/sourceforge/nanoxml/XMLElement.java
@@ -39,7 +39,7 @@
/**
* XMLElement is a representation of an XML object. The object is able to parse
* XML code.
- * <p><dl>
+ * <dl>
* <dt><b>Parsing XML Data</b></dt>
* <dd>
* You can parse XML data using the following code:
@@ -83,7 +83,6 @@
* {@link #createAnotherElement() createAnotherElement}
* which has to return a new copy of the receiver.
* </dd></dl>
- * </p>
*
* @see net.sourceforge.nanoxml.XMLParseException
*
@@ -178,7 +177,8 @@
private boolean ignoreWhitespace;
/**
- * Character read too much.<br/>
+ * Character read too much.
+ * <p>
* This character provides push-back functionality to the input reader
* without having to use a PushbackReader.
* If there is no such character, this field is {@code '\0'}.
@@ -210,7 +210,8 @@
private int parserLineNr;
/**
- * Creates and initializes a new XML element.<br/>
+ * Creates and initializes a new XML element.
+ * <p>
* Calling the construction is equivalent to:
* <ul><li>{@code new XMLElement(new Hashtable(), false, true)}</li></ul>
*
@@ -400,7 +401,8 @@
}
/**
- * Returns an attribute of the element.<br/>
+ * Returns an attribute of the element.
+ * <p>
* If the attribute doesn't exist, {@code null} is returned.
*
* @param name The name of the attribute.
@@ -535,7 +537,7 @@
* The new name.
*
* <dl><dt><b>Preconditions:</b></dt><dd>
- * <ul><li{@code name != null}</li>
+ * <ul><li>{@code name != null}</li>
* <li>{@code name} is a valid XML identifier</li>
* </ul></dd></dl>
*/
@@ -597,7 +599,8 @@
}
/**
- * This method scans an identifier from the current reader.<br/>
+ * This method scans an identifier from the current reader.
+ * <p>
* The scanned whitespace is appended to {@code result}.
*
* @return the next character following the whitespace.
@@ -625,7 +628,8 @@
}
/**
- * This method scans a delimited string from the current reader.<br/>
+ * This method scans a delimited string from the current reader.
+ * <p>
* The scanned string without delimiters is appended to {@code string}.
*
* <dl><dt><b>Preconditions:</b></dt><dd>
@@ -653,8 +657,10 @@
/**
* Scans a {@code #PCDATA} element. CDATA sections and entities are
- * resolved.<br/>
- * The next < char is skipped.<br/>
+ * resolved.
+ * <p>
+ * The next < char is skipped.
+ *
* The scanned data is appended to {@code data}.
*
* <dl><dt><b>Preconditions:</b></dt><dd>
@@ -831,7 +837,8 @@
}
/**
- * Scans the data for literal text.<br/>
+ * Scans the data for literal text.
+ * <p>
* Scanning stops when a character does not match or after the complete
* text has been checked, whichever comes first.
*
@@ -985,7 +992,8 @@
}
/**
- * Resolves an entity. The name of the entity is read from the reader.<br/>
+ * Resolves an entity. The name of the entity is read from the reader.
+ * <p>
* The value of the entity is appended to {@code buf}.
*
* @param buf Where to put the entity value.
diff --git a/netx/net/sourceforge/nanoxml/XMLParseException.java b/netx/net/sourceforge/nanoxml/XMLParseException.java
--- a/netx/net/sourceforge/nanoxml/XMLParseException.java
+++ b/netx/net/sourceforge/nanoxml/XMLParseException.java
@@ -32,7 +32,8 @@
* An XMLParseException is thrown when an error occures while parsing an XML
* string.
* <p>
- * $Revision: 1.1 $<br/>
+ * $Revision: 1.1 $</p>
+ * <p>
* $Date: 2002/08/03 04:05:32 $</p>
*
* @see net.sourceforge.nanoxml.XMLElement
More information about the distro-pkg-dev
mailing list