PageRenderTime 8ms CodeModel.GetById 1ms app.highlight 2ms RepoModel.GetById 1ms app.codeStats 1ms

/wiki/TagIgnore.wiki

http://jsdoc-toolkit.googlecode.com/
Unknown | 26 lines | 19 code | 7 blank | 0 comment | 0 complexity | 00a0591a5ee5d775a66e2efaf5b9e2c2 MD5 | raw file
 1#summary @ignore
 2
 3== The @ignore Tag ==
 4
 5The `@ignore` tag tells !JsDoc Toolkit to exclude an object in your code from the documentation, when it otherwise would be documented. This tag tags precedence over any other mechanism, and guarantess that an ignored ogject will not be documented.
 6
 7=== Syntax ===
 8
 9{{{
10@ignore
11}}}
12
13=== Example ===
14
15{{{
16/**
17 * @constructor
18 * @ignore
19 */
20function Foo() {
21    this.bar = function() {
22    }
23}
24}}}
25
26Note that in this example, both `Foo` and `bar` will be excluded from the documentation; when a parent object is ignored, all of its members are also ignored.