PageRenderTime 32ms CodeModel.GetById 26ms app.highlight 2ms RepoModel.GetById 1ms app.codeStats 0ms

/wiki/MetaTags.wiki

http://jsdoc-toolkit.googlecode.com/
Unknown | 48 lines | 32 code | 16 blank | 0 comment | 0 complexity | d1678fa04a48b3ed8962a178c3536575 MD5 | raw file
 1
 2== Meta Tags ==
 3
 4A special syntax provides processing instructions to !JsDoc Toolkit. Any doc comment starting with the characters `/**#` is treated as a "meta tag."
 5
 6=== Tag Sharing ===
 7
 8The tag sharing instruction allows you to apply a set of tags to a whole range of variables being documented in your code.
 9
10==== Syntax ====
11{{{
12/**#@+
13 * anyTags
14 */
15}}}
16
17  * anyTags - Required: any group of tags you wish to share.
18  * Note: The affect of this instruction is in force until the end of the file or the next `/**#@-*/` doc comment is encountered.
19  
20==== Example ====
21
22The tags in the tag sharing instruction will be applied to all of these functions.
23
24{{{
25/**#@+
26   @private
27   @memberOf Foo
28*/
29
30function baz() {}
31function zop() {}
32function pez() {}
33
34/**#@-*/
35}}}
36
37In this example all three functions will be documented as private members of Foo. This syntax is more compact and convenient than creating three identical doc comments.
38
39=== Making Code Invisible ===
40
41The nocode meta tag tells the !JsDoc Toolkit parser to completely ignore the source code while it is in effect. This is the same as turning the -n commandline option on temporarily.
42
43==== Syntax ====
44{{{
45/**#nocode+*/
46}}}
47
48  * Note: The affect of this instruction is in force until the end of the file or the next `/**#nocode-*/` doc comment is encountered.