Changeset 63598 for trunk/src/js/media/controllers/state-machine.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/media/controllers/state-machine.js (modified) (2 diffs)

trunk/src/js/media/controllers/state-machine.js

@@ -36 +36 @@
          * @since 3.5.0
          *
-         * @param {string} id
+         * @param {string} id The ID of the state to fetch. If omitted, the active state is returned.
          * @return {wp.media.controller.State} Returns a State model from
          *                                     the StateMachine collection.
@@ -61 +61 @@
          * @since 3.5.0
          *
-         * @param {string} id
+         * @param {string} id The ID of the state to set as active.
          *
          * @fires wp.media.controller.State#deactivate