Friday, February 21, 2003 01:49 AM
To deprecate a class or method, use the @deprecated tag, as explained in How to Write Doc Comments for JavaDoc
. The paragraph following the @deprecated tag should explain why the item has been deprecated and suggest how the user can avoid using it.
It is not necessary to deprecate individual members of a deprecated class, unless of course the programmer wants to explain some specific point about one member.
Note: Deprecation applies to classes and to individual members, not to their names. It is possible for a single method to have deprecated and non-deprecated overloadings. It is possible for a non-deprecated member to hide or override a deprecated one, which removes deprecation. It is the responsibility of the programmer to deprecate overrides of a deprecated method, if in fact they should be deprecated.