Improve this page

@deprecated

Tag type: block tag

TSDoc standardization: core

The @deprecated tag indicates that an API item is no longer supported and may be removed in a future release. It should be followed by a sentence describing the recommended alternative. (This is optional in JSDoc, but required in AEDoc.) The @deprecated tag can be combined with any release tag (@internal, @alpha, @beta, or @public). It recursively applies to members of the container, e.g. if a class is deprecated, then so are all of its members.

Usage example:

/**
 * The base class for all graphical components.
 *
 * @deprecated The BaseWidget class has been superceded by the BaseControl class.
 * @public
 */
export class BaseWidget {
  ...
}

See also