sergiotarxz/Wordpress
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Docs: Correct alignment for some parameters in JS documentation.

Browse Source 
Follow-up to [48650].

See #43828.

git-svn-id: https://develop.svn.wordpress.org/trunk@48651 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Sergey Biryukov 2020-07-28 00:05:59 +00:00
parent 9ed92faaca
commit 72dfc468c5
4 changed files with 14 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
src/js/_enqueues/lib/image-edit.js
View File

@ -73,7 +73,7 @@
* @memberof imageEdit * @memberof imageEdit
* *
* @param {jQuery} el The element that should be modified. * @param {jQuery} el The element that should be modified.
* @param {boolean|number} s The state for the element. If set to true * @param {boolean|number} s The state for the element. If set to true
* the element is disabled, * the element is disabled,
* otherwise the element is enabled. * otherwise the element is enabled.
* The function is sometimes called with a 0 or 1 * The function is sometimes called with a 0 or 1
@ -841,7 +841,7 @@
* @memberof imageEdit * @memberof imageEdit
* *
* @param {number} postid The post ID. * @param {number} postid The post ID.
* @param {boolean} warn Warning message. * @param {boolean} warn Warning message.
* *
* @return {void|boolean} Returns false if there is a warning. * @return {void|boolean} Returns false if there is a warning.
*/ */

4
src/js/_enqueues/wp/api.js
View File

@ -186,7 +186,7 @@
* Extract a route part based on negative index. * Extract a route part based on negative index.
* *
* @param {string} route The endpoint route. * @param {string} route The endpoint route.
* @param {number} part The number of parts from the end of the route to retrieve. Default 1. * @param {number} part The number of parts from the end of the route to retrieve. Default 1.
* Example route `/a/b/c`: part 1 is `c`, part 2 is `b`, part 3 is `a`. * Example route `/a/b/c`: part 1 is `c`, part 2 is `b`, part 3 is `a`.
* @param {string} [versionString] Version string, defaults to `wp.api.versionString`. * @param {string} [versionString] Version string, defaults to `wp.api.versionString`.
* @param {boolean} [reverse] Whether to reverse the order when extracting the route part. Optional, default false. * @param {boolean} [reverse] Whether to reverse the order when extracting the route part. Optional, default false.
@ -361,7 +361,7 @@
* Build a helper function to retrieve related model. * Build a helper function to retrieve related model.
* *
* @param {string} parentModel The parent model. * @param {string} parentModel The parent model.
* @param {number} modelId The model ID if the object to request * @param {number} modelId The model ID if the object to request
* @param {string} modelName The model name to use when constructing the model. * @param {string} modelName The model name to use when constructing the model.
* @param {string} embedSourcePoint Where to check the embedds object for _embed data. * @param {string} embedSourcePoint Where to check the embedds object for _embed data.
* @param {string} embedCheckField Which model field to check to see if the model has data. * @param {string} embedCheckField Which model field to check to see if the model has data.

4
src/js/_enqueues/wp/customize/controls.js vendored
View File

@ -2166,8 +2166,8 @@
* Loads controls into the section from data received from loadThemes(). * Loads controls into the section from data received from loadThemes().
* *
* @since 4.9.0 * @since 4.9.0
* @param {Array} themes - Array of theme data to create controls with. * @param {Array} themes - Array of theme data to create controls with.
* @param {number} page - Page of results being loaded. * @param {number} page - Page of results being loaded.
* @return {void} * @return {void}
*/ */
loadControls: function( themes, page ) { loadControls: function( themes, page ) {

16
src/js/_enqueues/wp/customize/selective-refresh.js
View File

@ -59,14 +59,14 @@ wp.customize.selectiveRefresh = ( function( $, api ) {
* *
* @since 4.5.0 * @since 4.5.0
* *
* @param {string} id - Unique identifier for the partial instance. * @param {string} id - Unique identifier for the partial instance.
* @param {Object} options - Options hash for the partial instance. * @param {Object} options - Options hash for the partial instance.
* @param {string} options.type - Type of partial (e.g. nav_menu, widget, etc) * @param {string} options.type - Type of partial (e.g. nav_menu, widget, etc)
* @param {string} options.selector - jQuery selector to find the container element in the page. * @param {string} options.selector - jQuery selector to find the container element in the page.
* @param {Array} options.settings - The IDs for the settings the partial relates to. * @param {Array} options.settings - The IDs for the settings the partial relates to.
* @param {string} options.primarySetting - The ID for the primary setting the partial renders. * @param {string} options.primarySetting - The ID for the primary setting the partial renders.
* @param {boolean} options.fallbackRefresh - Whether to refresh the entire preview in case of a partial refresh failure. * @param {boolean} options.fallbackRefresh - Whether to refresh the entire preview in case of a partial refresh failure.
* @param {Object} [options.params] - Deprecated wrapper for the above properties. * @param {Object} [options.params] - Deprecated wrapper for the above properties.
*/ */
initialize: function( id, options ) { initialize: function( id, options ) {
var partial = this; var partial = this;