@release

  • constructor
3.3
documentjs.tags.release  

Specifies the release of a @param, @signature, @function or @property.

@release RELEASE 

/**
 * Retrieves a list of orders.
 * @release 3.2
 */
 find: function( params, success ) {

Parameters

  1. RELASE {String}

    A release number like: 1.2.3.

Release for a param

Put @release after @param to tag the param with a release number:

/**
 * Retrieves a list of orders.
 * @param {{}} params Parameters to filter orders.
 * @release 3.2.1
 */
 find: function( params, success ) {

Release for a signature

Put @release after @signature to tag the param with a release number:

/**
 * Retrieves a list of orders.
 * @signature `Order.find(params, success)`
 * @release 3.2
 * @param {{}} params Parameters to filter orders.
 */
 find: function( params, success ) {