diff options
| author | Omair Majid <[email protected]> | 2014-01-24 10:05:12 -0500 |
|---|---|---|
| committer | Omair Majid <[email protected]> | 2014-01-24 10:05:12 -0500 |
| commit | 5e29c4c6084a30b3102782ab7489ffb1a25c6c27 (patch) | |
| tree | 073f67fb02f95193e9374b16475eea950c9a6d87 /netx | |
| parent | b5fe255a252eaabac547973403fcfac7e6033c24 (diff) | |
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.
Diffstat (limited to 'netx')
18 files changed, 102 insertions, 107 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 <[email protected]> */ 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 <[email protected], [email protected]> * */ 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) => (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()) { diff --git a/netx/net/sourceforge/nanoxml/XMLElement.java b/netx/net/sourceforge/nanoxml/XMLElement.java index 6a6e8b2..c205b8b 100644 --- a/netx/net/sourceforge/nanoxml/XMLElement.java +++ b/netx/net/sourceforge/nanoxml/XMLElement.java @@ -43,11 +43,11 @@ import net.sourceforge.jnlp.util.logging.OutputController; * <DT><B>Parsing XML Data</B></DT> * <DD> * You can parse XML data using the following code: - * <UL><CODE> - * XMLElement xml = new XMLElement();<BR> - * FileReader reader = new FileReader("filename.xml");<BR> + * <UL>{@code + * XMLElement xml = new XMLElement(); + * FileReader reader = new FileReader("filename.xml"); * xml.parseFromReader(reader); - * </CODE></UL></DD></DL> + * }</UL></DD></DL> * <DL><DT><B>Retrieving Attributes</B></DT> * <DD> * You can enumerate the attributes of an element using the method @@ -55,15 +55,15 @@ import net.sourceforge.jnlp.util.logging.OutputController; * The attribute values can be retrieved using the method * {@link #getAttribute(java.lang.String) getAttribute}. * The following example shows how to list the attributes of an element: - * <UL><CODE> - * XMLElement element = ...;<BR> - * Enumeration enum = element.enumerateAttributeNames();<BR> - * while (enum.hasMoreElements()) {<BR> - * String key = (String) enum.nextElement();<BR> - * String value = (String) element.getAttribute(key);<BR> - * System.out.println(key + " = " + value);<BR> + * <UL>{@code + * XMLElement element = ...; + * Enumeration enum = element.enumerateAttributeNames(); + * while (enum.hasMoreElements()) { + * String key = (String) enum.nextElement(); + * String value = (String) element.getAttribute(key); + * System.out.println(key + " = " + value); * } - * </CODE></UL></DD></DL> + * }</UL></DD></DL> * <DL><DT><B>Retrieving Child Elements</B></DT> * <DD> * You can enumerate the children of an element using @@ -74,9 +74,7 @@ import net.sourceforge.jnlp.util.logging.OutputController; * <DL><DT><B>Elements Containing Character Data</B></DT> * <DD> * If an elements contains character data, like in the following example: - * <UL><CODE> - * <title>The Title</title> - * </CODE></UL> + * <UL>{@code <title>The Title</title>}</UL> * you can retrieve that data using the method * {@link #getContent() getContent}. * </DD></DL> @@ -163,7 +161,7 @@ public class XMLElement { * The line number where the element starts. * * <dl><dt><b>Invariants:</b></dt><dd> - * <ul><li><code>lineNr >= 0</code> + * <ul><li>{@code lineNr >= 0} * </ul></dd></dl> */ private int lineNr; @@ -215,17 +213,17 @@ public class XMLElement { /** * Creates and initializes a new XML element. * Calling the construction is equivalent to: - * <ul><code>new XMLElement(new Hashtable(), false, true) - * </code></ul> + * <ul><li><code>new XMLElement(new Hashtable(), false, true) + * </code></li></ul> * * <dl><dt><b>Postconditions:</b></dt><dd> - * <ul><li>countChildren() => 0 - * <li>enumerateChildren() => empty enumeration - * <li>enumeratePropertyNames() => empty enumeration - * <li>getChildren() => empty vector - * <li>getContent() => "" - * <li>getLineNr() => 0 - * <li>getName() => null + * <ul><li>countChildren() => 0 + * <li>enumerateChildren() => empty enumeration + * <li>enumeratePropertyNames() => empty enumeration + * <li>getChildren() => empty vector + * <li>getContent() => "" + * <li>getLineNr() => 0 + * <li>getName() => null * </ul></dd></dl> * */ @@ -252,7 +250,7 @@ public class XMLElement { * <code>true</code> if the case of element and attribute names have * to be ignored. * - * </dl><dl><dt><b>Preconditions:</b></dt><dd> + * <dl><dt><b>Preconditions:</b></dt><dd> * <ul><li><code>entities != null</code> * <li>if <code>fillBasicConversionTable == false</code> * then <code>entities</code> contains at least the following @@ -261,14 +259,14 @@ public class XMLElement { * </ul></dd></dl> * * <dl><dt><b>Postconditions:</b></dt><dd> - * <ul><li>countChildren() => 0 - * <li>enumerateChildren() => empty enumeration - * <li>enumeratePropertyNames() => empty enumeration - * <li>getChildren() => empty vector - * <li>getContent() => "" - * <li>getLineNr() => 0 - * <li>getName() => null - * </ul></dd></dl><dl> + * <ul><li>countChildren() => 0 + * <li>enumerateChildren() => empty enumeration + * <li>enumeratePropertyNames() => empty enumeration + * <li>getChildren() => empty vector + * <li>getContent() => "" + * <li>getLineNr() => 0 + * <li>getName() => null + * </ul></dd></dl> * */ protected XMLElement(Hashtable<String, char[]> entities, @@ -306,17 +304,17 @@ public class XMLElement { * @param child * The child element to add. * - * </dl><dl><dt><b>Preconditions:</b></dt><dd> + * <dl><dt><b>Preconditions:</b></dt><dd> * <ul><li><code>child != null</code> * <li><code>child.getName() != null</code> * <li><code>child</code> does not have a parent element * </ul></dd></dl> * * <dl><dt><b>Postconditions:</b></dt><dd> - * <ul><li>countChildren() => old.countChildren() + 1 - * <li>enumerateChildren() => old.enumerateChildren() + child - * <li>getChildren() => old.enumerateChildren() + child - * </ul></dd></dl><dl> + * <ul><li>countChildren() => old.countChildren() + 1 + * <li>enumerateChildren() => old.enumerateChildren() + child + * <li>getChildren() => old.enumerateChildren() + child + * </ul></dd></dl> * */ public void addChild(XMLElement child) { @@ -331,7 +329,7 @@ public class XMLElement { * @param value * The value of the attribute. * - * </dl><dl><dt><b>Preconditions:</b></dt><dd> + * <dl><dt><b>Preconditions:</b></dt><dd> * <ul><li><code>name != null</code> * <li><code>name</code> is a valid XML identifier * <li><code>value != null</code> @@ -339,9 +337,9 @@ public class XMLElement { * * <dl><dt><b>Postconditions:</b></dt><dd> * <ul><li>enumerateAttributeNames() - * => old.enumerateAttributeNames() + name - * <li>getAttribute(name) => value - * </ul></dd></dl><dl> + * => old.enumerateAttributeNames() + name + * <li>getAttribute(name) => value + * </ul></dd></dl> * */ public void setAttribute(String name, @@ -356,7 +354,7 @@ public class XMLElement { * Returns the number of child elements of the element. * * <dl><dt><b>Postconditions:</b></dt><dd> - * <ul><li><code>result >= 0</code> + * <ul><li>{@code result >= 0} * </ul></dd></dl> * */ @@ -402,7 +400,7 @@ public class XMLElement { * This method returns <code>0</code> there is no associated source data. * * <dl><dt><b>Postconditions:</b></dt><dd> - * <ul><li><code>result >= 0</code> + * <ul><li>{@code result >= 0} * </ul></dd></dl> */ public int getLineNr() { @@ -415,10 +413,10 @@ public class XMLElement { * * @param name The name of the attribute. * - * </dl><dl><dt><b>Preconditions:</b></dt><dd> + * <dl><dt><b>Preconditions:</b></dt><dd> * <ul><li><code>name != null</code> * <li><code>name</code> is a valid XML identifier - * </ul></dd></dl><dl> + * </ul></dd></dl> * */ public Object getAttribute(String name) { @@ -443,7 +441,7 @@ public class XMLElement { * @param reader * The reader from which to retrieve the XML data. * - * </dl><dl><dt><b>Preconditions:</b></dt><dd> + * <dl><dt><b>Preconditions:</b></dt><dd> * <ul><li><code>reader != null</code> * <li><code>reader</code> is not closed * </ul></dd></dl> @@ -453,7 +451,7 @@ public class XMLElement { * parsed from the reader * <li>the reader points to the first character following the last * '>' character of the XML element - * </ul></dd></dl><dl> + * </ul></dd></dl> * * @throws java.io.IOException * If an error occured while reading the input. @@ -473,7 +471,7 @@ public class XMLElement { * @param startingLineNr * The line number of the first line in the data. * - * </dl><dl><dt><b>Preconditions:</b></dt><dd> + * <dl><dt><b>Preconditions:</b></dt><dd> * <ul><li><code>reader != null</code> * <li><code>reader</code> is not closed * </ul></dd></dl> @@ -483,7 +481,7 @@ public class XMLElement { * parsed from the reader * <li>the reader points to the first character following the last * '>' character of the XML element - * </ul></dd></dl><dl> + * </ul></dd></dl> * * @throws java.io.IOException * If an error occured while reading the input. @@ -544,7 +542,7 @@ public class XMLElement { * @param name * The new name. * - * </dl><dl><dt><b>Preconditions:</b></dt><dd> + * <dl><dt><b>Preconditions:</b></dt><dd> * <ul><li><code>name != null</code> * <li><code>name</code> is a valid XML identifier * </ul></dd></dl> @@ -561,7 +559,7 @@ public class XMLElement { * @param result * The buffer in which the scanned identifier will be put. * - * </dl><dl><dt><b>Preconditions:</b></dt><dd> + * <dl><dt><b>Preconditions:</b></dt><dd> * <ul><li><code>result != null</code> * <li>The next character read from the reader is a valid first * character of an XML identifier. @@ -570,7 +568,7 @@ public class XMLElement { * <dl><dt><b>Postconditions:</b></dt><dd> * <ul><li>The next character read from the reader won't be an identifier * character. - * </ul></dd></dl><dl> + * </ul></dd></dl> */ protected void scanIdentifier(StringBuffer result) throws IOException { @@ -613,7 +611,7 @@ public class XMLElement { * * @return the next character following the whitespace. * - * </dl><dl><dt><b>Preconditions:</b></dt><dd> + * <dl><dt><b>Preconditions:</b></dt><dd> * <ul><li><code>result != null</code> * </ul></dd></dl> */ @@ -640,7 +638,7 @@ public class XMLElement { * The scanned string without delimiters is appended to * <code>string</code>. * - * </dl><dl><dt><b>Preconditions:</b></dt><dd> + * <dl><dt><b>Preconditions:</b></dt><dd> * <ul><li><code>string != null</code> * <li>the next char read is the string delimiter * </ul></dd></dl> @@ -668,7 +666,7 @@ public class XMLElement { * The next < char is skipped. * The scanned data is appended to <code>data</code>. * - * </dl><dl><dt><b>Preconditions:</b></dt><dd> + * <dl><dt><b>Preconditions:</b></dt><dd> * <ul><li><code>data != null</code> * </ul></dd></dl> */ @@ -696,7 +694,7 @@ public class XMLElement { * Scans a special tag and if the tag is a CDATA section, append its * content to <code>buf</code>. * - * </dl><dl><dt><b>Preconditions:</b></dt><dd> + * <dl><dt><b>Preconditions:</b></dt><dd> * <ul><li><code>buf != null</code> * <li>The first < has already been read. * </ul></dd></dl> @@ -751,7 +749,7 @@ public class XMLElement { /** * Skips a comment. * - * </dl><dl><dt><b>Preconditions:</b></dt><dd> + * <dl><dt><b>Preconditions:</b></dt><dd> * <ul><li>The first <!-- has already been read. * </ul></dd></dl> */ @@ -791,9 +789,9 @@ public class XMLElement { * @param bracketLevel The number of open square brackets ([) that have * already been read. * - * </dl><dl><dt><b>Preconditions:</b></dt><dd> + * <dl><dt><b>Preconditions:</b></dt><dd> * <ul><li>The first <! has already been read. - * <li><code>bracketLevel >= 0</code> + * <li><code>bracketLevel >= 0</code> * </ul></dd></dl> */ protected void skipSpecialTag(int bracketLevel) @@ -848,7 +846,7 @@ public class XMLElement { * * @param literal the literal to check. * - * </dl><dl><dt><b>Preconditions:</b></dt><dd> + * <dl><dt><b>Preconditions:</b></dt><dd> * <ul><li><code>literal != null</code> * </ul></dd></dl> */ @@ -890,7 +888,7 @@ public class XMLElement { * * @param elt The element that will contain the result. * - * </dl><dl><dt><b>Preconditions:</b></dt><dd> + * <dl><dt><b>Preconditions:</b></dt><dd> * <ul><li>The first < has already been read. * <li><code>elt != null</code> * </ul></dd></dl> @@ -1001,7 +999,7 @@ public class XMLElement { * * @param buf Where to put the entity value. * - * </dl><dl><dt><b>Preconditions:</b></dt><dd> + * <dl><dt><b>Preconditions:</b></dt><dd> * <ul><li>The first & has already been read. * <li><code>buf != null</code> * </ul></dd></dl> @@ -1043,7 +1041,7 @@ public class XMLElement { * * @param ch The character to push back. * - * </dl><dl><dt><b>Preconditions:</b></dt><dd> + * <dl><dt><b>Preconditions:</b></dt><dd> * <ul><li>The read-back buffer is empty. * <li><code>ch != '\0'</code> * </ul></dd></dl> @@ -1058,7 +1056,7 @@ public class XMLElement { * * @param name The name of the entity. * - * </dl><dl><dt><b>Preconditions:</b></dt><dd> + * <dl><dt><b>Preconditions:</b></dt><dd> * <ul><li><code>name != null</code> * </ul></dd></dl> */ @@ -1074,7 +1072,7 @@ public class XMLElement { * @param name The name of the entity. * @param value The value of the entity. * - * </dl><dl><dt><b>Preconditions:</b></dt><dd> + * <dl><dt><b>Preconditions:</b></dt><dd> * <ul><li><code>name != null</code> * <li><code>value != null</code> * </ul></dd></dl> @@ -1100,7 +1098,7 @@ public class XMLElement { * * @param context The context in which the error occured. * - * </dl><dl><dt><b>Preconditions:</b></dt><dd> + * <dl><dt><b>Preconditions:</b></dt><dd> * <ul><li><code>context != null</code> * <li><code>context.length() > 0</code> * </ul></dd></dl> @@ -1117,7 +1115,7 @@ public class XMLElement { * @param charSet The set of characters (in human readable form) that was * expected. * - * </dl><dl><dt><b>Preconditions:</b></dt><dd> + * <dl><dt><b>Preconditions:</b></dt><dd> * <ul><li><code>charSet != null</code> * <li><code>charSet.length() > 0</code> * </ul></dd></dl> @@ -1134,7 +1132,7 @@ public class XMLElement { * @param charSet The set of characters (in human readable form) that was * expected. * @param ch The character that was received instead. - * </dl><dl><dt><b>Preconditions:</b></dt><dd> + * <dl><dt><b>Preconditions:</b></dt><dd> * <ul><li><code>charSet != null</code> * <li><code>charSet.length() > 0</code> * </ul></dd></dl> @@ -1149,7 +1147,7 @@ public class XMLElement { * * @param name The name of the entity. * - * </dl><dl><dt><b>Preconditions:</b></dt><dd> + * <dl><dt><b>Preconditions:</b></dt><dd> * <ul><li><code>name != null</code> * <li><code>name.length() > 0</code> * </ul></dd></dl> diff --git a/netx/net/sourceforge/nanoxml/XMLParseException.java b/netx/net/sourceforge/nanoxml/XMLParseException.java index 329dea4..e3e64fe 100644 --- a/netx/net/sourceforge/nanoxml/XMLParseException.java +++ b/netx/net/sourceforge/nanoxml/XMLParseException.java @@ -53,7 +53,7 @@ public class XMLParseException * <code>NO_LINE</code> if the line number is unknown. * * <dl><dt><b>Invariants:</b></dt><dd> - * <ul><li><code>lineNr > 0 || lineNr == NO_LINE</code> + * <ul><li>{@code lineNr > 0 || lineNr == NO_LINE} * </ul></dd></dl> */ private int lineNr; @@ -64,13 +64,13 @@ public class XMLParseException * @param name The name of the element where the error is located. * @param message A message describing what went wrong. * - * </dl><dl><dt><b>Preconditions:</b></dt><dd> - * <ul><li><code>message != null</code> + * <dl><dt><b>Preconditions:</b></dt><dd> + * <ul><li>{@code message != null} * </ul></dd></dl> * * <dl><dt><b>Postconditions:</b></dt><dd> - * <ul><li>getLineNr() => NO_LINE - * </ul></dd></dl><dl> + * <ul><li>{@code getLineNr() => NO_LINE} + * </ul></dd></dl> */ public XMLParseException(String name, String message) { @@ -88,14 +88,14 @@ public class XMLParseException * @param lineNr The number of the line in the input. * @param message A message describing what went wrong. * - * </dl><dl><dt><b>Preconditions:</b></dt><dd> + * <dl><dt><b>Preconditions:</b></dt><dd> * <ul><li><code>message != null</code> * <li><code>lineNr > 0</code> * </ul></dd></dl> * * <dl><dt><b>Postconditions:</b></dt><dd> - * <ul><li>getLineNr() => lineNr - * </ul></dd></dl><dl> + * <ul><li>{@code getLineNr() => lineNr} + * </ul></dd></dl> */ public XMLParseException(String name, int lineNr, |