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. }