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

Standard Doclet and the @Deprecated annotation

XMLWordPrintable

    • b54
    • sparc
    • solaris_9



      Name: ss24420 Date: 05/03/2004



      There's a new @Deprecated annotation: see java.lang.Deprecated.
      To javac this functions just like the @deprecated javadoc tag.
      To the javadoc tool, it's just another annotation (and the tag,
      likewise, is just another tag). How should the Standard Doclet
      treat this annotation?

      The annotation doesn't really take the place of the javadoc tag,
      since the latter includes descriptive text about when the API
      element was deprecated, suggested alternatives, etc.

      Certainly if both the annotation and the javadoc tag are found
      on an API element, nothing special need be done with the annotation.
      If the tag is found but not the annotation, behave as always.
      If the annotation is found but not the tag, I think this should
      be treated by the Doclet as if there were an implicit @deprecated tag
      with no explanatory text.


      ======================================================================

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

              Created:
              Updated:
              Resolved:
              Imported:
              Indexed: