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

Correct the unknown Javadoc tags

XMLWordPrintable

    • Icon: Bug Bug
    • Resolution: Won't Fix
    • Icon: P4 P4
    • None
    • 1.3.0
    • docs
    • None
    • sparc
    • solaris_2.6

      Javadoc 1.4 has better error-checking for Javadoc tag names -- it no longer
      ignores unknown tags by default (and allows you to explicitly ignore them
      using "-tag name:X"). As a result, we are now able to check the comments
      for errors in tag names.

      J2SE 1.4 RC has the following unknown tags. For a detailed description of
      which files they are in, see the Comments section of this bug.

          @spec
          @note
          @revised
          @constraints
          @overrides
          @seealso
          @
          @parm
          @returns
          @alink
          @throw
          @param (on a field)
          @deprecated (on a class) [Not an error]
          @id
          @width
          @height
          @bitDepth
          @refreshRate

      We need to determine:

      - Which are typos or errors that need correcting
          In this case, we should correct the tag names in the source code doc comments

      - Which are deliberate and legitimate (used by doclets other than the standard doclet)
        and should be ignored during the J2SE run
          In this case, we should add "-tag name:X" to the Javadoc command
          for each tag, to suppress Javadoc warnings. Please list these legitimate
          tags in this bug report so Eric Armstrong can suppress their warnings and
          we can do the same for the J2SE makefile.

      This list of tags was generated when Eric Armstrong generated what he calls the
      "simple" API docs using the standard doclet (for the JCP API diffs). He saved
      the warnings/errors to a log file, then grepped for the word "unknown",
      discarded @beaninfo, then manually edited the file to remove redundant
      directory names.

            bpatel Bhavesh Patel (Inactive)
            dkramersunw Douglas Kramer (Inactive)
            Votes:
            0 Vote for this issue
            Watchers:
            0 Start watching this issue

              Created:
              Updated:
              Resolved:
              Imported:
              Indexed: