Previous Up Next
@copyright phpDocumentor tags @example

@deprecated

Document elements that have been deprecated and should not be used as they may be removed at any time from a future version

Gregory Beaver
Tag Documentation written by cellog@php.net
Copyright 2002, Gregory Beaver
(phpDocumentor 0.1+)
@deprecated version/info string

Description

The @deprecated tag is used to document the deprecation version or other information of any element that can be documented except for page (global variable, include, constant, function, define, class, variable, method). If present, phpDocumentor will display the optional version/info string unaltered.

Use @deprecated to notify users of deprecated elements that should not be used any longer

Example

Here's an example:

  1. /**
  2.  * @deprecated deprecated since version 2.0
  3.  */
  4. function uselessfunction()
  5. {
  6. ...
  7. }
  8.  
  9. /**
  10.  * also legal
  11.  * @deprecated
  12.  */
  13. class stupidclass
  14. {
  15. ...
  16. }

Previous Up Next
@copyright phpDocumentor tags @example

Documentation generated on Mon, 05 Dec 2011 21:18:37 -0600 by phpDocumentor 1.4.4