/wiki/TagRequires.wiki

http://jsdoc-toolkit.googlecode.com/ · Unknown · 24 lines · 16 code · 8 blank · 0 comment · 0 complexity · 5dfb1902f8d6fb7de040e30881510c72 MD5 · raw file 

    

  1. #summary @requires
    2. 

  2. 

  3. == The @requires Tag ==
    4. 

  4. 

  5. The `@requires` tag allows you to document a resource that is needed to use this code.
    6. 

  6. 

  7. === Syntax ===
    8. 

  8. 

  9. {{{
    10. 

  10. @requires requireDescription
    11. 

  11. }}}
    12. 

  12. 

  13.   * requireDescription - Required: the name or description of the required resource.
    14. 

  14. 

  15. === Example ===
    16. 

  16. 

  17. {{{
    18. 

  18. /**
    19. 

  19.  * @requires ColorPicker
    20. 

  20.  */
    21. 

  21. function chooseColor() {
    22. 

  22. }
    23. 

  23. }}}
    24.