/wiki/TagDeprecated.wiki

http://jsdoc-toolkit.googlecode.com/ · Unknown · 23 lines · 16 code · 7 blank · 0 comment · 0 complexity · 0510080289d96731d9e9c75ee5649d97 MD5 · raw file 

    

  1. #summary @deprecated
    2. 

  2. 

  3. == The @deprecated Tag ==
    4. 

  4. 

  5. The `@deprecated` that a constructor, a method, or property should no longer be used.
    6. 

  6. 

  7. === Syntax ===
    8. 

  8. 

  9. {{{
    10. 

  10. @deprecated deprecatedDescription
    11. 

  11. }}}
    12. 

  12. 

  13.   * deprecatedDescription - Any information you wish to provide about the deprecated status of the object.
    14. 

  14. 

  15. === Example ===
    16. 

  16. 

  17. {{{
    18. 

  18. /**
    19. 

  19.  * @deprecated Since version 0.5. You should now use NewFoo.
    20. 

  20.  */
    21. 

  21. function Foo() {
    22. 

  22. }
    23. 

  23. }}}inks to other wiki pages
    24.