@author

nene edited this page Aug 9, 2012 · 3 revisions

Synopsis:

@author Some name...

Documents the author of the class or member.

By default JSDuck hides the author information. To make it visible you can override it with a custom @author tag. Generally the author information is tracked by the source control anyway and you shouldn't duplicate it, but sometimes you might want to explicitly denote the ownership of a particular class.

Example:

/**
 * @class MyClass
 * My neat class.
 * @author John Doe <john@example.com>
 */