Make WordPress Core


Ignore:
Timestamp:
09/11/2026 10:50:50 AM (12 hours ago)
Author:
afercia
Message:

General: Fix indentation and alignments in JavaScript inline documentation blocks.

Enables the following JSDoc rules:

  • jsdoc/check-alignment
  • jsdoc/check-indentation
  • jsdoc/check-line-alignment
  • jsdoc/require-hyphen-before-param-description -> never

Fixes all the reported violations. Also removes hyphens before descriptions.

Part of the effort to improve JS inline documentation for 7.2.

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

Props afercia, mukesh27.
See #66033.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/js/_enqueues/lib/admin-bar.js

    r63406 r63600  
    175175         *
    176176         * @param {NodeList} topMenuItems All menu items.
    177          * @param {Event} event The click event.
     177         * @param {Event}    event        The click event.
    178178         */
    179179        function mobileHover( topMenuItems, event ) {
     
    261261         * @since 5.3.1
    262262         *
    263          * @param {HTMLElement} element The HTML element.
     263         * @param {HTMLElement} element   The HTML element.
    264264         * @param {string}      className The class name.
    265265         * @return {boolean} Whether the element has the className.
     
    287287         * @since 5.3.1
    288288         *
    289          * @param {HTMLElement} element The HTML element.
     289         * @param {HTMLElement} element   The HTML element.
    290290         * @param {string}      className The class name.
    291291         */
     
    316316         * @since 5.3.1
    317317         *
    318          * @param {HTMLElement} element The HTML element.
     318         * @param {HTMLElement} element   The HTML element.
    319319         * @param {string}      className The class name.
    320320         */
     
    396396         * @since 5.3.1
    397397         *
    398          * @param {HTMLElement} el Element to get parent.
    399          * @param {string} selector CSS selector to match.
     398         * @param {HTMLElement} el       Element to get parent.
     399         * @param {string}      selector CSS selector to match.
    400400         *
    401401         * @return {HTMLElement|null} The closest matching element or null if not found.
Note: See TracChangeset for help on using the changeset viewer.