@deprecated

(phpDocumentor 0.1+ )

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

Description

@deprecated [version/info string]

You may use the @deprecated tag 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

Here's an example:

/**
* @deprecated deprecated since version 2.0
*/
function uselessfunction()
{
...
}

/**
* also legal
* @deprecated
*/
class stupidclass
{
...
}