Name: rmT116609 Date: 08/07/2003


FULL PRODUCT VERSION :
java version "1.4.2"
Java(TM) 2 Runtime Environment, Standard Edition (build 1.4.2-b28)
Java HotSpot(TM) Client VM (build 1.4.2-b28, mixed mode)

FULL OS VERSION :
Microsoft Windows 2000 [Version 5.00.2195]

A DESCRIPTION OF THE PROBLEM :
The extra checking introduced in javadoc 1.4... is incorrectly implemented,
and in many cases (especially my case) makes javadoc 1.4.X unusable.

The problem is that HTML markup is not stripped from the input before
a compare with names extracted from the source is made.

The JavaSoft "DocCheck Utility Package, 1.2 beta1" tool had the same problem that I corrected as shown
below.

In the class DocCheck

// DMG
// if (nextE.parameterName().equals(nameR)) {
         if (nameR.equals(stripHTML(nextE.parameterName()))) {
// END DMG
 
// DMG Extension
   static String stripHTML(String string) {
      int loopCnt = string.length();
      int state = 0;
      int idx = 0;
      char[] result = new char[loopCnt];
      boolean skipChar = false;
      for (int i = 0;i < loopCnt;i++) {
         char next = string.charAt(i);
         skipChar = false;
         switch (state) {
            case 0: // Start state
               if (next == '<') {
                  state = 1;
                  skipChar = true;
               }
               break;
            case 1:
               skipChar = true;
               if (next == '>')
                  state = 0;
               break;
         }
         if (! skipChar)
            result[idx++] = next;
      }
      return new String(result, 0, idx);
   }




STEPS TO FOLLOW TO REPRODUCE THE PROBLEM :
javadoc the "Source code for an executable test case" with javadoc 1.4.1 and 1.4.2 and compare the results with javadoc 1.3.1

EXPECTED VERSUS ACTUAL BEHAVIOR :
EXPECTED -
The results from javadoc 1.3.1
ACTUAL -
The @param tag is ignored if the first word after "@param" has any HTML markup

ERROR MESSAGES/STACK TRACES THAT OCCUR :
javadoc 1.4.1 does not produce any error or warning messages
javadoc 1.4.2 reports the following (on the sample code):

E:\j\de\gaskin\bugs\JavaDocBug01.java:10: warning - @param argument "<b>args</b>" is not a parameter name.

REPRODUCIBILITY :
This bug can be reproduced always.

---------- BEGIN SOURCE ----------
package de.gaskin.bugs;

/** Demonstrate a javadoc 1.4.2 bug.
*/

public class JavaDocBug01 {
   /** JVM Entry point.
    * @param <b>args</b> the command line parameters.
    */
   public static void main(String[] args) {
   }
}

---------- END SOURCE ----------

CUSTOMER SUBMITTED WORKAROUND :
Use javadoc 1.3.1 until the problem is resolved

Release Regression From : 1.3.1_08
The above release value was the last known release where this
bug was known to work. Since then there has been a regression.

(Incident Review ID: 190835)
======================================================================