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

javadoc spec: doesn't say how to handle erroneous input

XMLWordPrintable

    • Icon: Bug Bug
    • Resolution: Fixed
    • Icon: P4 P4
    • 1.4.0
    • 1.4.0
    • tools
    • 1.4
    • generic, sparc
    • solaris_7, solaris_9
    • Verified

      I believe in general that javadoc should accept erroneous source files whenever possible with at most a warning. Recent changes to javadoc made it accept many more cases of erroneous programs. But my changes have no justification based on the specification for javadoc.

      Nowhere is it specified whether or not javadoc should accept or reject erroneous programs, or even whether either behavior is acceptable for javadoc. It would be helpful if such behavior were specified, and I believe adding something to the documentation on this topic would be very helpful to users. Something along the lines of "javadoc will often allow you to generate documentation for sources that are incomplete or erroneous." In addition, such documentation would provide some guidance to SQE, who should otherwise rely on the JLS for what behavior is acceptable.

      ###@###.### 2001-08-21

            dkramersunw Douglas Kramer (Inactive)
            gafter Neal Gafter (Inactive)
            Votes:
            0 Vote for this issue
            Watchers:
            0 Start watching this issue

              Created:
              Updated:
              Resolved:
              Imported:
              Indexed: