javadoc fixes

Author: rbri

src/main/java/org/htmlunit/cyberneko/HTMLScanner.java

@@ -419,7 +419,7 @@ public class HTMLScanner implements XMLDocumentSource, XMLLocator, HTMLComponent
     /** Error reporter. */
     protected HTMLErrorReporter fErrorReporter;
 
-    /** Error reporter. */
+    /** Encoding translator. */
     protected EncodingTranslator fEncodingTranslator;
 
     /** Doctype declaration public identifier. */
@@ -488,14 +488,10 @@ public class HTMLScanner implements XMLDocumentSource, XMLLocator, HTMLComponent
      */
     protected final SpecialScanner fSpecialScanner = new SpecialScanner();
 
-    /**
-     * Special scanner used script tags.
-     */
+    /** Special scanner used script tags. */
     protected final ScriptScanner fScriptScanner = new ScriptScanner();
 
-    /**
-     * Special scanner used script tags.
-     */
+    /** Special scanner used for plaintext content. */
     protected final PlainTextScanner fPlainTextScanner = new PlainTextScanner();
 
     // temp vars
@@ -1652,7 +1648,7 @@ public interface Scanner {
          * @param complete True if the scanner should not return until scanning is
          *                 complete.
          *
-         * @return True if additional scanning is required.
+         * @return One of SCAN_TRUE, SCAN_EOF, or SCAN_FALSE indicating the scanning result.
          *
          * @throws IOException Thrown if I/O error occurs.
          */
@@ -2503,11 +2499,11 @@ private void eof() {
         }
 
         /**
-         * Scans the content of <noscript&gr;: it doesn't get parsed but is considered as
-         * plain text when feature {@link HTMLScanner#PARSE_NOSCRIPT_CONTENT} is set to
-         * false.
+         * Scans the content of <noscript> <noframes>, <noembed&get;, and <iframe>
+         * it doesn't get parsed but is considered as plain text
+         * when feature {@link HTMLScanner#PARSE_NOSCRIPT_CONTENT} is set to false.
          *
-         * @param tagName the tag for which content is scanned (one of "/noscript",
+         * @param tagNameWithLeadingSlash the tag for which content is scanned (one of "/noscript",
          *                "/noframes", "/noembed", "/iframe")
          * @throws IOException on error
          */
@@ -2969,7 +2965,7 @@ else if (c == '>') {
          *
          * @param empty Is used for a second return value to indicate whether the start
          *              element tag is empty (e.g. "/>").
-         * @return ename
+         * @return One of SCAN_TRUE, SCAN_FALSE, or SCAN_EOF.
          * @throws IOException in case of io problems
          */
         protected int scanStartElement(final boolean[] empty) throws IOException {

src/main/java/org/htmlunit/cyberneko/SynthesizedItem.java

@@ -90,7 +90,7 @@ public boolean isSynthesized() {
     }
 
     /**
-     * Save to return this instance because it does not have state
+     * Safe to return this instance because it does not have state
      *
      * @return this instance
      */

src/main/java/org/htmlunit/cyberneko/xerces/xni/XMLString.java

@@ -804,7 +804,7 @@ public int hashCode() {
      * represented by two UTF-16 code points.
      *
      * @param codePoint The character value.
-     * @return this instance for fluid programming
+     * @return true if the code point was valid and appended, false if a replacement character was used instead
      *
      * @throws IllegalArgumentException if the specified
      *          {@code codePoint} is not a valid Unicode code point.
@@ -886,7 +886,7 @@ public XMLString toUpperCase(final Locale locale) {
      * This lowercases an XMLString in place and will likely not
      * consume extra memory unless the character might grow. This
      * conversion can be incorrect for certain characters from some
-     * locales. See {@link String#toUpperCase()}.
+     * locales. See {@link String#toLowerCase()}.
      *
      * <p>Note: We change the current XMLString and don't get a copy back
      * but this instance.
@@ -1121,7 +1121,7 @@ public void ignorableWhitespace(final ContentHandler contentHandler) throws SAXE
     public void comment(final LexicalHandler lexicalHandler) throws SAXException {
         lexicalHandler.comment(data_, 0, length_);
     }
-    
+
     /**
      * Returns true if the first {@code prefix.length()} chars of this buffer
      * match {@code prefix} case-insensitively, where {@code prefix} is assumed
@@ -1142,7 +1142,7 @@ public boolean startsWithLowerCase(final String lowercasePrefix) {
         }
         return true;
     }
-    
+
     /**
      * Returns the char at {@code index}, or {@code defaultChar} if index is
      * out of bounds.