PageRenderTime 20ms CodeModel.GetById 15ms app.highlight 1ms RepoModel.GetById 2ms app.codeStats 0ms

/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
 3== The @public Tag ==
 4
 5The `@public` indicates that an inner variable should be documented as if it were public.
 6
 7=== Syntax ===
 8
 9{{{
10@public
11}}}
12
13=== Example ===
14
15{{{
16/**
17 * @constructor
18 */
19function Foo() {
20    /**@public*/
21    function inner() {
22    }
23}
24}}}
25
26In 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.
27 
28=== See Also ===
29
30  * The [TagPrivate @private] tag.
31  * The [TagStatic @static] tag.
32  
33