Comment Tag Attributes
Most of the comment tags allow specification of one or more attributes.
Common Attributes
Attributes that could be specified to all comment tags:
| @author | Specify the author(s) of a function/file/class/etc |
| @deprecated | Indicate that a function/file/class/etc is deprecated |
| @see | Refer to another part of the documentation |
| @since | Specify the version in which a class/file/function/etc was introduced |
| @timestamp | Insert the timestamp when the documentation project was created |
| @version | Shows current version of software |
Attributes of function-like elements
The following attributes could appear in declaration of function-like tags like @function, @ifunction, @constructor and @event:
| @paramset | Used to declare an alternate parameter set |
| @return | Describe the return behavior of a function |
| @throws | Describe the exceptions thrown by a function |
| @param | Parameter of a function or constructor |
| @... | Define secondary properties of an @param |
Attributes of functions, variables and other members
| @inheritdesc | Inherit the description of an '@extend'ed class/interface |
Attributes of classes and interfaces
| @extends | Define the inheritance structure of a class or interface |
Attributes of classes
| @implements | Declare that a class implements an interface |
Attributes of modules
| @requires | Specifies that current module requires another one to be loaded and/or initialized first |
