/wiki/TagPublic.wiki
http://jsdoc-toolkit.googlecode.com/ · Unknown · 33 lines · 22 code · 11 blank · 0 comment · 0 complexity · a0d2d357f434bc98effbf3b1f1313af5 MD5 · raw file
- #summary @public
- == The @public Tag ==
- The `@public` indicates that an inner variable should be documented as if it were public.
- === Syntax ===
- {{{
- @public
- }}}
- === Example ===
- {{{
- /**
- * @constructor
- */
- function Foo() {
- /**@public*/
- function inner() {
- }
- }
- }}}
- 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.
-
- === See Also ===
- * The [TagPrivate @private] tag.
- * The [TagStatic @static] tag.