Changeset 63598 for trunk/src/js/_enqueues/admin/postbox.js

Timestamp:

09/11/2026 06:29:08 AM (6 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/_enqueues/admin/postbox.js (modified) (1 diff)

trunk/src/js/_enqueues/admin/postbox.js

@@ -247 +247 @@
                  * @memberof postboxes
                  *
-                 * @param {string} page The page we are currently on.
-                 * @param {Object} [args]
-                 * @param {Function} args.pbshow A callback that is called when a postbox opens.
-                 * @param {Function} args.pbhide A callback that is called when a postbox closes.
+                 * @param {string}   page          The page we are currently on.
+                 * @param {Object}   [args]        Optional arguments for the postbox toggles.
+                 * @param {Function} [args.pbshow] A callback that is called when a postbox opens.
+                 * @param {Function} [args.pbhide] A callback that is called when a postbox closes.
                  * @return {void}
                  */