Changeset 63598 for trunk/src/js/media/models/attachments.js

Timestamp:

09/11/2026 06:29:08 AM (7 hours ago)

Author:

afercia

Message:

General: Enable the JSDoc rule require-param-description.

Enables the JSDoc rule require-param-description and fixes all the reported violations.
Part of the effort to improve JS inline documentation for 7.2.

Developed in ​https://github.com/WordPress/wordpress-develop/pull/13475

Props afercia, westonruter.
See #66033.

File:

• trunk/src/js/media/models/attachments.js (modified) (16 diffs)

trunk/src/js/media/models/attachments.js

@@ -31 +31 @@
          * Initializes the Attachments collection.
          *
-         * @param {Array} [models=[]] Array of models used to populate the collection.
-         * @param {Object} [options={}]
+         * @param {Array}  [models=[]]  Optional. Array of models used to populate the collection.
+         * @param {Object} [options={}] Optional. Additional options for the collection.
          */
         initialize: function( models, options ) {
@@ -82 +82 @@
          * @access private
          *
-         * @param {Backbone.Model} model
-         * @param {string} orderby
+         * @param {Backbone.Model} model   The model that triggered the change.
+         * @param {string}         orderby The new orderby value.
          */
         _changeOrderby: function( model, orderby ) {
@@ -102 +102 @@
          * @access private
          *
-         * @param {Backbone.Model} model
-         * @param {boolean} query
+         * @param {Backbone.Model} model The model that triggered the change.
+         * @param {boolean}        query The new query value.
          */
         _changeQuery: function( model, query ) {
@@ -118 +118 @@
          * @access private
          *
-         * @param {Backbone.Model} model
+         * @param {Backbone.Model} model The model that triggered the change.
          */
         _changeFilteredProps: function( model ) {
@@ -164 +164 @@
          * Checks whether an attachment is valid.
          *
-         * @param {wp.media.model.Attachment} attachment
+         * @param {wp.media.model.Attachment} attachment The attachment to validate.
          * @return {boolean} True if the attachment is valid, false otherwise.
          */
@@ -179 +179 @@
          * Adds or removes an attachment to the collection depending on its validity.
          *
-         * @param {wp.media.model.Attachment} attachment
-         * @param {Object} options
+         * @param {wp.media.model.Attachment} attachment The attachment to validate and potentially add or remove.
+         * @param {Object}                    options    Additional options for the operation.
          * @return {wp.media.model.Attachments} Returns itself to allow chaining.
          */
@@ -199 +199 @@
          * Adds or removes all attachments from another collection depending on each one's validity.
          *
-         * @param {wp.media.model.Attachments} attachments
-         * @param {Object} [options={}]
+         * @param {wp.media.model.Attachments} attachments  The attachments collection to validate against.
+         * @param {Object}                     [options={}] Additional options for the operation.
          *
          * @fires wp.media.model.Attachments#reset
@@ -282 +282 @@
          * @access private
          *
-         * @param {wp.media.model.Attachments} attachment
-         * @param {wp.media.model.Attachments} attachments
-         * @param {Object} options
+         * @param {wp.media.model.Attachments} attachment  The attachment to validate.
+         * @param {wp.media.model.Attachments} attachments The attachments collection the attachment belongs to.
+         * @param {Object}                     options     Additional options for the operation.
          *
          * @return {wp.media.model.Attachments} Returns itself to allow chaining.
@@ -302 +302 @@
          * @access private
          *
-         * @param {wp.media.model.Attachments} attachments
-         * @param {Object} options
+         * @param {wp.media.model.Attachments} attachments The attachments collection to validate against.
+         * @param {Object}                     options     Additional options for the operation.
          * @return {wp.media.model.Attachments} Returns itself to allow chaining.
          */
@@ -356 +356 @@
          * server persistence by itself.
          *
-         * @param {Object} options
+         * @param {Object} options Additional options for the operation.
          * @return {Promise} A promise that resolves when the request is complete.
          */
@@ -425 +425 @@
          *
          * @param {Object|Array} response The raw response Object/Array.
-         * @param {Object} xhr
+         * @param {Object}       xhr      The XMLHttpRequest object.
          * @return {Array} The array of model attributes to be added to the collection
          */
@@ -506 +506 @@
          * and its subclasses. @see wp.media.model.Attachments._changeOrderby().
          *
-         * @param {Backbone.Model} a
-         * @param {Backbone.Model} b
-         * @param {Object} options
+         * @param {Backbone.Model} a       The first attachment model to compare.
+         * @param {Backbone.Model} b       The second attachment model to compare.
+         * @param {Object}         options Additional options for the comparison.
          * @return {number} -1 if the first model should come before the second,
          *                   0 if they are of the same rank and
@@ -543 +543 @@
                  * to our server-side searching.
                  *
-                 * @param {wp.media.model.Attachment} attachment
+                 * @param {wp.media.model.Attachment} attachment The attachment to filter based on the search query.
                  *
                  * @this wp.media.model.Attachments
@@ -563 +563 @@
                  *
                  * @static
-                 * @param {wp.media.model.Attachment} attachment
+                 * @param {wp.media.model.Attachment} attachment The attachment to filter based on its type.
                  *
                  * @this wp.media.model.Attachments
@@ -592 +592 @@
                  *
                  * @static
-                 * @param {wp.media.model.Attachment} attachment
+                 * @param {wp.media.model.Attachment} attachment The attachment to filter based on its uploadedTo property.
                  *
                  * @this wp.media.model.Attachments
@@ -610 +610 @@
                  *
                  * @static
-                 * @param {wp.media.model.Attachment} attachment
+                 * @param {wp.media.model.Attachment} attachment The attachment to filter based on its status property.
                  *
                  * @this wp.media.model.Attachments