@deprecated


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

DocBlocks

  • Class docBlock
  • Class Method docBlock
  • Class Property docBlock
  • Constant docBlock

Notes

  • The @deprecated tag is used to document the deprecation version or other information of any element that can be documented except for page.
  • If present, phpDocumenter will display the optional version/info string unaltered.
  • If element is superseded by another element it is RECOMMENDED that this tag be immediately followed by the @see tag pointing to the new element.

Example

[cc lang=php”]
/*
* @deprecated version/info string
*/
[/cc]

  1. No comments yet.
(will not be published)

Why ask?