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

stddoclet: need to remove inconsistent warning message

XMLWordPrintable

    • Icon: Bug Bug
    • Resolution: Fixed
    • Icon: P4 P4
    • 1.4.0
    • 1.4.0
    • tools
    • beta2
    • generic
    • generic
    • Verified

      I believe there is a new warning message that was added to
      javadoc for Merlin:

      javadoc: warning - Method org.xml.sax.helpers.XMLReaderAdapter.skippedEntity
              declares that it throws org.xml.sax.SAXException,
              but does not document it.

      The JDK puts out hundreds of these warnings. Relatively speaking,
      this is not a very important warning, and it drowns out other
      more important warnings.

      I believe we should probably turn off this warning and move the
      check to DocCheck doclet (or create another warning level in javadoc
      for it).

      The reason is because this warning is inconsistent with the other
      warnings. We do not produce warnings that the parameters or
      return values are not documented, so I see no need to warn about
      Exceptions.

      If we want to add more error-checking to Javadoc, I suggest
      we consider introducing warning levels and the ability to turn them
      on and off.

            jhosunw Jamie Ho (Inactive)
            jhosunw Jamie Ho (Inactive)
            Votes:
            0 Vote for this issue
            Watchers:
            0 Start watching this issue

              Created:
              Updated:
              Resolved:
              Imported:
              Indexed: