PageRenderTime 159ms CodeModel.GetById 32ms RepoModel.GetById 20ms app.codeStats 1ms

/wiki/TagPublic.wiki

http://jsdoc-toolkit.googlecode.com/
Unknown | 33 lines | 22 code | 11 blank | 0 comment | 0 complexity | a0d2d357f434bc98effbf3b1f1313af5 MD5 | raw file
  1. #summary @public
  2. == The @public Tag ==
  3. The `@public` indicates that an inner variable should be documented as if it were public.
  4. === Syntax ===
  5. {{{
  6. @public
  7. }}}
  8. === Example ===
  9. {{{
  10. /**
  11. * @constructor
  12. */
  13. function Foo() {
  14. /**@public*/
  15. function inner() {
  16. }
  17. }
  18. }}}
  19. In the above example the inner function will appear as if it were a public member of Foo (an instance member by default). Use the `@static` tag to indicate that the inner function should be documented as a public static member.
  20. === See Also ===
  21. * The [TagPrivate @private] tag.
  22. * The [TagStatic @static] tag.