Changeset 26991

Timestamp:

01/21/2014 05:36:24 PM (11 years ago)

Author:

wonderboymusic

Message:

Make some @param types more specific in media-models.js.

See #26870.

File:

• trunk/src/wp-includes/js/media-models.js (modified) (13 diffs)

trunk/src/wp-includes/js/media-models.js

@@ -185 +185 @@
     Attachment = media.model.Attachment = Backbone.Model.extend({
         /**
+         * Triggered when attachment details change
+         *
          * @param {string} method
-         * @param {Backbone.Model} model
+         * @param {wp.media.model.Attachment} model
          * @param {Object} [options={}]
+         *
          * @returns {Promise}
          */
@@ -267 +270 @@
         },
         /**
+         * Convert date strings into Date objects.
+         *
          * @param {Object} resp
          * @returns {Object}
@@ -275 +280 @@
             }
 
-            // Convert date strings into Date objects.
             resp.date = new Date( resp.date );
             resp.modified = new Date( resp.modified );
@@ -283 +287 @@
          * @param {Object} data
          * @param {Object} options
+         *
+         * @this Backbone.Model
+         *
          * @returns {Promise}
          */
@@ -311 +318 @@
         /**
          * @param {string} id
-         * @param {Backbone.Model} attachment
+         * @param {Backbone.Model|undefined} attachment
          * @returns {wp.media.model.Attachment}
          */
@@ -480 +487 @@
 
         /**
-         * @param {Backbone.Collection} attachments
+         * @param {wp.media.model.Attachments} attachments
          * @param {object} [options={}]
          * @returns {wp.media.model.Attachments} Returns itself to allow chaining
@@ -497 +504 @@
         },
         /**
-         * @param {Backbone.Collection} attachments
+         * @param {wp.media.model.Attachments} attachments
          * @returns {wp.media.model.Attachments} Returns itself to allow chaining
          */
@@ -510 +517 @@
         },
         /**
-         * @param {Backbone.Collection} attachments
+         * @param {wp.media.model.Attachments} attachments
          * @returns {wp.media.model.Attachments} Returns itself to allow chaining
          */
@@ -530 +537 @@
          * @access private
          *
-         * @param {Backbone.Model} attachment
-         * @param {Backbone.Collction} attachments
+         * @param {wp.media.model.Attachments} attachment
+         * @param {wp.media.model.Attachments} attachments
          * @param {Object} options
+         *
          * @returns {wp.media.model.Attachments} Returns itself to allow chaining
          */
@@ -547 +555 @@
          * @access private
          *
-         * @param {Backbone.Collction} attachments
+         * @param {wp.media.model.Attachments} attachments
          * @param {Object} options
          * @returns {wp.media.model.Attachments} Returns itself to allow chaining
@@ -555 +563 @@
         },
         /**
-         * @param {Backbone.Collction} attachments
+         * @param {wp.media.model.Attachments} attachments
          * @returns {wp.media.model.Attachments} Returns itself to allow chaining
          */
@@ -760 +768 @@
      *
      * @static
-     * @returns {Attachments}
+     * @returns {wp.media.model.Attachments}
      */
     media.query = function( props ) {
@@ -1055 +1063 @@
 
         /**
-         *
-         * @param {Backbone.Model} model
+         * Triggered when toggling (clicking on) an attachment in the modal
+         *
+         * @param {undefined|boolean|wp.media.model.Attachment} model
          *
          * @fires wp.media.model.Selection#selection:single