Uploaded image for project: 'JDK'
  1. JDK
  2. JDK-4658163

REGRESSION: Formatting first argument to @param with HTML deletes the parameter

XMLWordPrintable

    • Icon: Bug Bug
    • Resolution: Not an Issue
    • Icon: P3 P3
    • None
    • 1.4.0, 1.4.0_01, 1.4.2
    • tools
    • generic, x86, sparc
    • generic, solaris_2.3, windows_2000

      For java 1.4.0-b92, wrapping the parameter name in HTML, like '<EM>...</EM>'
      completely ignores the @param command and Javadoc issues no warnings or
      errors. I also found nothing in any of the writeups, such as the "What's New
      in Javadoc 1.4" mentioning this behavior. This worked perfectly well under
      Javadoc 1.3.1_02.

      Is this a feature, a bug, or what?

      Example:

      ///////// snip...BEGIN ParamBug.java.....///////////
      public class ParamBug
      {

          /**
           * Demonstrates a bug parsing '@param' that worked under Java 1.3.1.
           * @param <EM>firstParam</EM> the first parameter of the bug example.
           */

          public void paramBugExample (String firstParam)
              {
              }
      }
      ///////// snip...END ParamBug.java.....///////////

      INSTRUCTIONS:

      1) place ParamBug.java in some directory and have location of javadoc on PATH.
      2) cd <location of ParamBug.java>
      3) execute javadoc -breakiterator -d . ParamBug.java
      4) Check the ParamBug.html file and notice the missing param!

      1.3.1:

      <DL>
      <DD>Demonstrates a bug parsing '@param' that worked under Java 1.3.1.<DD><DL>
      <DT><B>Parameters:</B><DD><CODE><EM>firstParam</EM></CODE> - the first parameter of the bug example.</DL>
      </DD>
      </DL>

      1.4.0:

      <DL>
      <DD>Demonstrates a bug parsing '@param' that worked under Java 1.3.1.
      <P>
      <DD><DL>
      </DL>
      </DD>
      </DL>

      This bug is reproducable under Win2000 and Win98.

            mtrudeau Michel Trudeau
            dkramersunw Douglas Kramer (Inactive)
            Votes:
            0 Vote for this issue
            Watchers:
            0 Start watching this issue

              Created:
              Updated:
              Resolved:
              Imported:
              Indexed: