WordPress.org
Get WordPress

Make WordPress Core

Changeset 63514


Ignore:
Timestamp:
09/07/2026 11:44:25 AM (2 weeks ago)
Author:
afercia
Message:

General: Add missing descriptions to several JS docblocks in the enqueues directory.

Part of the effort to improve JS inline documentation for WordPress 7.2. Preparation for the introduction of the JSDoc rule jsdoc/require-description.

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

See #66033.

Location:
trunk/src/js/_enqueues
Files:
19 edited

Legend:

Unmodified
Added
Removed

  • trunk/src/js/_enqueues/admin/application-passwords.js

    r63406 r63514  
    44
    55/**
     6 * Handles the Application Passwords functionality in the user profile screen.
     7 *
    68 * @param {JQueryStatic} $ The jQuery object.
    79 */

  • trunk/src/js/_enqueues/admin/edit-comments.js

    r63406 r63514  
    33
    44/**
    5  * Handles updating and editing comments.
    65 * @output wp-admin/js/edit-comments.js
    76 */
    87
    98/**
     9 * Handles updating and editing comments.
     10 *
    1011 * @param {JQueryStatic} $ The jQuery object.
    1112 */

  • trunk/src/js/_enqueues/admin/post.js

    r63406 r63514  
    1616
    1717/**
     18 * Handles the dynamic functionality needed on post and term pages.
     19 *
    1820 * @param {JQueryStatic} $ The jQuery object.
    1921 */
    … …  
    257259
    258260/**
    259  * Heartbeat refresh nonces.
     261 * Handles the Heartbeat refresh nonces.
    260262 *
    261263 * @param {JQueryStatic} $ The jQuery object.
    … …  
    305307
    306308/**
    307  * All post and postbox controls and functionality.
     309 * Handles all post and postbox controls and functionality.
    308310 *
    309311 * @param {JQueryStatic} $ The jQuery object.
    … …  
    13291331
    13301332/**
    1331  * TinyMCE word count display
     1333 * Handles the TinyMCE word count display.
    13321334 *
    13331335 * @param {JQueryStatic}         $       The jQuery object.

  • trunk/src/js/_enqueues/admin/user-profile.js

    r63406 r63514  
    66
    77/**
     8 * Handles the user profile functionality.
     9 *
    810 * @param {JQueryStatic} $ The jQuery object.
    911 */

  • trunk/src/js/_enqueues/lib/accordion.js

    r63406 r63514  
    3131
    3232/**
     33 * Handles the accordion functionality.
     34 *
    3335 * @param {JQueryStatic} $ The jQuery object.
    3436 */

  • trunk/src/js/_enqueues/lib/auth-check.js

    r63406 r63514  
    11/**
    2  * Interim login dialog.
    3  *
    42 * @output wp-includes/js/wp-auth-check.js
    53 */
    64
    75/**
     6 * Handles the interim login dialog.
     7 *
    88 * @param {JQueryStatic} $ The jQuery object.
    99 */

  • trunk/src/js/_enqueues/lib/color-picker.js

    r63406 r63514  
    66
    77/**
     8 * Handles the color picker functionality.
     9 *
    810 * @param {JQueryStatic} $     The jQuery object.
    911 * @param {undefined}    undef The undefined value.

  • trunk/src/js/_enqueues/lib/list-revisions.js

    r63406 r63514  
    11/**
     2 * @output wp-includes/js/wp-list-revisions.js
     3 */
     4
     5/**
     6 * Hides the revisions radio buttons to stop selecting reverse comparisons
     7 *
    28 * @param {Window} w The global window object.
    3  * @output wp-includes/js/wp-list-revisions.js
    49 */
    510

  • trunk/src/js/_enqueues/lib/lists.js

    r63407 r63514  
    66
    77/**
     8 * Handles the dynamic functionality needed for lists.
     9 *
    810 * @param {JQueryStatic} $ The jQuery object.
    911 */

  • trunk/src/js/_enqueues/lib/nav-menu.js

    r63407 r63514  
    11/**
    2  * WordPress Administration Navigation Menu
    3  * Interface JS functions
     2 * @output wp-admin/js/nav-menu.js
     3 */
     4
     5/* global menus, postboxes, columns, isRtl, ajaxurl, wpNavMenu */
     6
     7/**
     8 * Handles the WordPress Administration Navigation Menu Interface functionality.
    49 *
    510 * @version 2.0.0
     11 * @package WordPress
    612 *
    7  * @package WordPress
    8  * @output wp-admin/js/nav-menu.js
    9  */
    10 
    11 /* global menus, postboxes, columns, isRtl, ajaxurl, wpNavMenu */
    12 
    13 /**
    1413 * @param {JQueryStatic} $ The jQuery object.
    1514 */

  • trunk/src/js/_enqueues/wp/api-request.js

    r63407 r63514  
     1/**
     2 * @output wp-includes/js/api-request.js
     3 */
     4
    15/**
    26 * Thin jQuery.ajax wrapper for WP REST API requests.
    … …  
    1216 * @since 5.6.0 Added overriding of the "PUT" and "DELETE" methods with "POST".
    1317 *              Added an "application/json" Accept header to all requests.
    14  * @output wp-includes/js/api-request.js
    15  */
    16 
    17 /**
     18 *
    1819 * @param {JQueryStatic} $ The jQuery object.
    1920 */

  • trunk/src/js/_enqueues/wp/api.js

    r63407 r63514  
    11/**
     2 * @output wp-includes/js/wp-api.js
     3 */
     4
     5/**
     6 * Initialize the WordPress REST API client.
     7 *
    28 * @param {Window}    window    The global window object.
    39 * @param {undefined} undefined The undefined value.
    4  * @output wp-includes/js/wp-api.js
    510 */
    6 
    711(function( window, undefined ) {
    812
    … …  
    3438})( window );
    3539
     40/**
     41 * Sets up the WordPress REST API client with utilities and Backbone model mixins for managing API resources.
     42 *
     43 * @param {Window}    window    The global window object.
     44 * @param {undefined} undefined The undefined value.
     45 */
    3646(function( window, undefined ) {
    3747
    … …  
    827837// Suppress warning about parse function's unused "options" argument:
    828838/* jshint unused:false */
     839
     840/**
     841 * Creates the base Backbone model for WordPress REST API.
     842 */
    829843(function() {
    830844
    … …  
    979993})();
    980994
     995/**
     996 * Creates the base Backbone collection for WordPress REST API.
     997 */
    981998( function() {
    982999
    … …  
    11361153} )();
    11371154
     1155/**
     1156 * Constructs Backbone models and collections from the WordPress REST API schema.
     1157 */
    11381158( function() {
    11391159

  • trunk/src/js/_enqueues/wp/code-editor.js

    r63407 r63514  
    139139
    140140/**
    141  * @param {JQueryStatic} $ The jQuery object.
    142  * @param {Object & {
    143  *   codeEditor: WpCodeEditor,
    144  *   CodeMirror: typeof import('codemirror'),
    145  * }} wp - WordPress namespace.
     141 * Handles the Code Editor (CodeMirror) functionality.
     142 *
     143 * @param {JQueryStatic} $  The jQuery object.
     144 * @param {wp}           wp The WordPress global object.
    146145 */
    147146( function( $, wp ) {
    … …  
    166165
    167166        /**
    168          * Configure linting.
     167         * Configures linting.
    169168         *
    170169         * @param {CodeEditorSettings} settings - Code editor settings.
    … …  
    193192
    194193                /**
    195                  * Get lint options.
     194                 * Gets the lint options.
    196195                 *
    197196                 * @return {CombinedLintOptions|false} Lint options.
    … …  
    237236                        linterOptions.onUpdateLinting = (function( onUpdateLintingOverridden ) {
    238237                                /**
     238                                 * Wraps the onUpdateLinting event to filter errors, detect state changes, and manage error notice visibility.
     239                                 *
    239240                                 * @param {LintAnnotation[]} annotations - Annotations.
    240241                                 * @param {LintAnnotation[]} annotationsSorted - Sorted annotations.
    … …  
    279280                        getLintOptions,
    280281                        /**
     282                         * Initializes the CodeMirror editor.
     283                         *
    281284                         * @param {CodeMirrorEditor} editor - Editor instance.
    282285                         * @return {void}

  • trunk/src/js/_enqueues/wp/customize/base.js

    r63454 r63514  
    228228        api.Value = api.Class.extend(/** @lends wp.customize.Value.prototype */{
    229229                /**
     230                 * Initializes the Value instance and configures callbacks and options.
     231                 *
    230232                 * @param {*}      initial   The initial value.
    231233                 * @param {Object} [options] Options to extend the instance with.

  • trunk/src/js/_enqueues/wp/editor/dfw.js

    r63407 r63514  
    44
    55/**
     6 * Handles the editor Distraction-Free Writing (DFW) functionality.
     7 *
    68 * @param {Window}       window    The global window object.
    79 * @param {JQueryStatic} $         The jQuery object.

  • trunk/src/js/_enqueues/wp/heartbeat.js

    r63407 r63514  
    11/**
    2  * Heartbeat API
     2 * @output wp-includes/js/heartbeat.js
     3 */
     4
     5/**
     6 * Handles the Heartbeat API.
    37 *
    48 * Heartbeat is a simple server polling API that sends XHR requests to
    … …  
    2529 *
    2630 * @since 3.6.0
    27  * @output wp-includes/js/heartbeat.js
    28  */
    29 
    30 /**
    3131 * @param {JQueryStatic} $         The jQuery object.
    3232 * @param {Window}       window    The global window object.

  • trunk/src/js/_enqueues/wp/media/editor.js

    r63407 r63514  
    55/* global getUserSetting, tinymce, QTags */
    66
    7 // WordPress, TinyMCE, and Media
    8 // -----------------------------
     7/**
     8 * Handles the initialization, refreshing and rendering of media editor components.
     9 *
     10 * @param {JQueryStatic}       $ The jQuery object.
     11 * @param {_.UnderscoreStatic} _ The Underscore.js object.
     12 */
    913(function($, _){
    1014        /**
    … …  
    334338
    335339        /**
     340         * Factory function that creates a media collection controller for managing gallery, playlist, and other media shortcodes.
     341         *
    336342         * @class wp.media.collection
    337343         *

  • trunk/src/js/_enqueues/wp/sanitize.js

    r63407 r63514  
    33 */
    44
     5/**
     6 * Provides helper functions to sanitize strings.
     7 */
    58( function () {
    69

  • trunk/src/js/_enqueues/wp/updates.js

    r63407 r63514  
    11/**
    2  * Functions for ajaxified updates, deletions and installs inside the WordPress admin.
     2 * @output wp-admin/js/updates.js
     3 */
     4
     5/* global pagenow, _wpThemeSettings */
     6
     7/**
     8 * Provides functions for ajaxified updates, deletions and installs inside the WordPress admin.
    39 *
    410 * @version 4.2.0
    5  * @output wp-admin/js/updates.js
    6  */
    7 
    8 /* global pagenow, _wpThemeSettings */
    9 
    10 /**
     11 *
    1112 * @param {JQueryStatic} $                                        The jQuery object.
    12  * @param {Object}       wp                                       WP object.
     13 * @param {Object}       wp                                       The WordPress global object.
    1314 * @param {Object}       settings                                 WP Updates settings.
    1415 * @param {string}       settings.ajax_nonce                      Ajax nonce.
Note: See TracChangeset for help on using the changeset viewer.