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

Revise deprecation documentation in guide docs for @Deprecated annotation

XMLWordPrintable

    • Icon: Bug Bug
    • Resolution: Fixed
    • Icon: P4 P4
    • 5.0
    • 5.0
    • docs
    • rc
    • generic
    • other

      Revise this documentation:

      http://java.sun.com/j2se/1.5.0/docs/guide/javadoc/deprecation/index.html

      based on the addition of the @Deprecated annotation in J2SE 1.5 and JLS 3.

        @Deprecated annotation marks a package element declaration, and does not
        take text as an argument.

        @deprecated tag provides the text that goes into the deprecation note.

      For 1.5.0, the annotation or tag alone or together will force a compiler warning.

      The upcoming JLS 3 will codify the meaning
      of the @Deprecated annotation in the specification of the language itself.
      Here's draft language:

          A program element annotated @Deprecated is one that programmers are
          discouraged from using, typically because it is dangerous, or because
          a better alternative exists. A compiler must produce a warning when a
          deprecated entity... is used....

            duke J. Duke
            dkramersunw Douglas Kramer (Inactive)
            Votes:
            0 Vote for this issue
            Watchers:
            0 Start watching this issue

              Created:
              Updated:
              Resolved:
              Imported:
              Indexed: