@deprecated

  • constructor
documentjs.tags.deprecated  

Marks a comment as deprecated.

@deprecated {VERSION} DESCRIPTION

Specifies a deprecation warning for a particular version. Multiple @deprecated tags can be used on a single comment.

This warnings add to the deprecated tag on docObjects.

Parameters

  1. VERSION {STRING}

    The version the deprecation occured within.

  2. DESCRIPTION {STRING}

    Text describing the deprecation.

Use

/**
 * @function
 * @deprecated {1.0} This method has been replaced 
 * by [can.Model.parseModel].
 *
 * @param {String} name
 */