IntenseWebs/WordPress
3
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Docs: Add missing full stops to @returns tags in JS docs, per the documentation standards.

Browse Source 
Props shital-patel, kalpshit.
Fixes #48305.
Built from https://develop.svn.wordpress.org/trunk@46799


git-svn-id: http://core.svn.wordpress.org/trunk@46599 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Sergey Biryukov
2019-11-29 16:56:02 +00:00
parent acd0a3ca99
commit 4a4afbd68c
10 changed files with 67 additions and 67 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
wp-admin/js/color-picker.js
View File

@@ -327,7 +327,7 @@
*
* @since 3.5.0
*
* @returns {string} The element's color
* @returns {string} The element's color.
*/
color: function( newColor ) {
if ( newColor === undef ) {

12
wp-admin/js/customize-controls.js
View File

@@ -1154,7 +1154,7 @@
*
* @param {Boolean} active
* @param {Object} [params]
* @returns {Boolean} false if state already applied
* @returns {Boolean} False if state already applied.
*/
_toggleActive: function ( active, params ) {
var self = this;
@@ -1173,7 +1173,7 @@
/**
* @param {Object} [params]
* @returns {Boolean} false if already active
* @returns {Boolean} False if already active.
*/
activate: function ( params ) {
return this._toggleActive( true, params );
@@ -1181,7 +1181,7 @@
/**
* @param {Object} [params]
* @returns {Boolean} false if already inactive
* @returns {Boolean} False if already inactive.
*/
deactivate: function ( params ) {
return this._toggleActive( false, params );
@@ -1201,7 +1201,7 @@
* @param {Boolean} expanded - The new state to apply.
* @param {Object} [params] - Object containing options for expand/collapse.
* @param {Function} [params.completeCallback] - Function to call when expansion/collapse is complete.
* @returns {Boolean} false if state already applied or active state is false
* @returns {Boolean} False if state already applied or active state is false.
*/
_toggleExpanded: function( expanded, params ) {
var instance = this, previousCompleteCallback;
@@ -1238,7 +1238,7 @@
/**
* @param {Object} [params]
* @returns {Boolean} false if already expanded or if inactive.
* @returns {Boolean} False if already expanded or if inactive.
*/
expand: function ( params ) {
return this._toggleExpanded( true, params );
@@ -1246,7 +1246,7 @@
/**
* @param {Object} [params]
* @returns {Boolean} false if already collapsed.
* @returns {Boolean} False if already collapsed.
*/
collapse: function ( params ) {
return this._toggleExpanded( false, params );

6
wp-admin/js/customize-nav-menus.js
View File

@@ -1962,7 +1962,7 @@
*
* @param {Boolean} expanded
* @param {Object} [params]
* @returns {Boolean} false if state already applied
* @returns {Boolean} False if state already applied.
*/
_toggleExpanded: api.Section.prototype._toggleExpanded,
@@ -1970,7 +1970,7 @@
* @since 4.6.0
*
* @param {Object} [params]
* @returns {Boolean} false if already expanded
* @returns {Boolean} False if already expanded.
*/
expand: api.Section.prototype.expand,
@@ -1990,7 +1990,7 @@
* @since 4.6.0
*
* @param {Object} [params]
* @returns {Boolean} false if already collapsed
* @returns {Boolean} False if already collapsed.
*/
collapse: api.Section.prototype.collapse,

10
wp-admin/js/customize-widgets.js
View File

@@ -1340,7 +1340,7 @@
*
* @param {Boolean} expanded
* @param {Object} [params]
* @returns {Boolean} false if state already applied
* @returns {Boolean} False if state already applied.
*/
_toggleExpanded: api.Section.prototype._toggleExpanded,
@@ -1348,7 +1348,7 @@
* @since 4.1.0
*
* @param {Object} [params]
* @returns {Boolean} false if already expanded
* @returns {Boolean} False if already expanded.
*/
expand: api.Section.prototype.expand,
@@ -1365,7 +1365,7 @@
* @since 4.1.0
*
* @param {Object} [params]
* @returns {Boolean} false if already collapsed
* @returns {Boolean} False if already collapsed.
*/
collapse: api.Section.prototype.collapse,
@@ -2060,8 +2060,8 @@
},
/**
* @param {string} widgetId or an id_base for adding a previously non-existing widget
* @returns {object|false} widget_form control instance, or false on error
* @param {string} widgetId or an id_base for adding a previously non-existing widget.
* @returns {object|false} widget_form control instance, or false on error.
*/
addWidget: function( widgetId ) {
var self = this, controlHtml, $widget, controlType = 'widget_form', controlContainer, controlConstructor,

4
wp-admin/js/editor.js
View File

@@ -658,8 +658,8 @@ window.wp = window.wp || {};
* Check the notes in the comments in the code below for more information on some gotchas
* and why this solution was chosen.
*
* @param {Object} editor The editor where we must find the selection
* @returns {(null|Object)} The selection range position in the editor
* @param {Object} editor The editor where we must find the selection.
* @returns {(null|Object)} The selection range position in the editor.
*/
function findBookmarkedPosition( editor ) {
// Get the TinyMCE `window` reference, since we need to access the raw selection.