/wiki/TagInner.wiki

 1#summary @inner
 2
 3== The @inner Tag ==
 4
 5Use the @inner tag to indicate the function is an inner function. Inner functions are declared in the scope of an outer function, and are not directly accessible from outside that outer function.
 6
 7=== Syntax ===
 8{{{
 9@inner
10}}}
11
12=== Examples ===
13
14In many cases this tag is not neccessary, as !JsDoc Toolkit can already recognize the fact that a function is an inner function on its own.
15
16{{{
17/**
18    @constructor
19 */ 
20Person = function() {
21    /** @inner */
22    function daydream() {
23    }
24}
25}}}
26
27Because of the limited scope of the Person function, the daydream function is not directly accessible from outside of Person. For this reason JsDoc Toolkit will also mark it as `@private`.
28
29=== See Also ===
30  * The [TagPrivate @private] tag.