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

/wiki/TagAuthor.wiki

http://jsdoc-toolkit.googlecode.com/
Unknown | 23 lines | 15 code | 8 blank | 0 comment | 0 complexity | 8d19b73b1c8a26b0b65717a23a61060d MD5 | raw file
 1#summary @author
 2
 3== The @author Tag ==
 4
 5The `@author` tag allows you to document the author of the code for a constructor, a method, or property.
 6
 7=== Syntax ===
 8
 9{{{
10@author authorDescription
11}}}
12
13  * authorDescription - Required: any information you wish to provide about the author, typically name and email address.
14
15=== Example ===
16
17{{{
18/**
19 * @author <a href="mailto:micmath@gmail.com">Michael Mathews</a>
20 */
21}}}
22
23Multiple author tags are allowed in one documentation comment if you wish. Note: that using HTML tags in the text of any tag is always allowed, but is only useful if your documentation is formatted as HTML.