/wiki/TagDefault.wiki

http://jsdoc-toolkit.googlecode.com/ · Unknown · 31 lines · 21 code · 10 blank · 0 comment · 0 complexity · df182888c311d8170f130ce693f8d415 MD5 · raw file 

    

  1. #summary @default
    2. 

  2. 

  3. == The @default Tag ==
    4. 

  4. 

  5. The `@default` tag allows you to document the default value of an object, including fields of classes.
    6. 

  6. 

  7. === Syntax ===
    8. 

  8. 

  9. {{{
    10. 

  10. @default valueDescription
    11. 

  11. }}}
    12. 

  12. 

  13.   * valueDescription - Required: a description of the default value.
    14. 

  14. 

  15. === Example ===
    16. 

  16. 

  17. {{{
    18. 

  18. /** @constructor */
    19. 

  19. function Page(title) {
    20. 

  20.     /**
    21. 

  21.      * @default "Undefined"
    22. 

  22.      */
    23. 

  23.      this.title = title || "Undefined";
    24. 

  24. }
    25. 

  25. }}}
    26. 

  26. 

  27. The `@default` tag is only recognized when applied to objects, it is not meaningful to use it with functions.
    28. 

  28. 

  29. === See Also ===
    30. 

  30. 

  31.   * The [TagType @type] tag can be used to document the type of an object's value, or the type of a value returned by a function. Contrast this with `@default` which documents what the actual default value is.
    32.