@type

nene edited this page Mar 21, 2012 · 1 revision

Synopsis:

@type {Type}
Property description...

@type Type
Property description...

Documents the type of a property, additionally marking the documented thing as a property.

The use of this tag is deprecated. It's only supported for backwards compatibility with old ext-doc. For new code always use the @property tag instead.

Example:

/**
 * @type {Number}
 * Current height of component.
 */
height: 5,

Again for backwards compatibility the @type tag allows the curly braces to be left off:

/**
 * @type Number
 * Current height of component.
 */
height: 5,