/wiki/TagType.wiki

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

    

  1. #summary @type
    2. 

  2. 

  3. == The @type Tag ==
    4. 

  4. 

  5. The `@type` tag allows you to document the type of value a variable refers to, or the type of value returned by a function.
    6. 

  6. 

  7. === Syntax ===
    8. 

  8. 

  9. {{{
    10. 

  10. @type typeName
    11. 

  11. }}}
    12. 

  12. 

  13.   * typeName - Required: the name of the type.
    14. 

  14. 

  15. === Example ===
    16. 

  16. 

  17. {{{
    18. 

  18. /**
    19. 

  19.  * @type Color
    20. 

  20.  */
    21. 

  21. function getColor() {
    22. 

  22. }
    23. 

  23. }}}
    24.