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

/wiki/TagClass.wiki

http://jsdoc-toolkit.googlecode.com/
Unknown | 28 lines | 20 code | 8 blank | 0 comment | 0 complexity | 1801941cc8c25bd8b8d666def3c28ee8 MD5 | raw file
 1#summary @class
 2
 3== The @class Tag ==
 4
 5Like the [TagConstructor @constructor] tag, the @class tag marks a function as being a constructor, but this tag also allows you to add a description of the class, rather than dscribe the constructor function.
 6
 7=== Syntax ===
 8{{{
 9@class description
10}}}
11
12  * description - Optional: the description of the class.
13
14=== Examples ===
15
16In this example there are two descriptions. The first description is untagged and describes the constructor function. The second description is part of the `@class` tag, and is used to describe the entire `Person` class. In addition, because of the presence of the `@class` tag, the function is also marked as being a constructor.
17
18{{{
19/**
20    Creates a new Person.
21    @class Represents a person. 
22 */ 
23Person = function() {
24}
25}}}
26
27=== See Also ===
28  * The [TagConstructor @constructor] tag.