diff options
author | Sergey Biryukov <sergeybiryukov@git.wordpress.org> | 2019-11-29 17:59:47 +0000 |
---|---|---|
committer | Sergey Biryukov <sergeybiryukov@git.wordpress.org> | 2019-11-29 17:59:47 +0000 |
commit | a03bb5454673d62dae26f50cd13619e92b23c884 (patch) | |
tree | faac09874cdb44e25548961f163c0f8a06dc9028 /src/js/_enqueues/wp/widgets/custom-html.js | |
parent | ea5bfe134f50b91680369f50b4d12d233b1f917c (diff) | |
download | wordpress-a03bb5454673d62dae26f50cd13619e92b23c884.tar.gz wordpress-a03bb5454673d62dae26f50cd13619e92b23c884.zip |
Docs: Replace `@returns` tags in JS docs with `@return`.
Per the documentation standards, `@returns` is an unsupported synonym, `@return` should be used instead:
https://make.wordpress.org/core/handbook/best-practices/inline-documentation-standards/javascript/
See #48303.
git-svn-id: https://develop.svn.wordpress.org/trunk@46800 602fd350-edb4-49c9-b593-d223f7449a82
Diffstat (limited to 'src/js/_enqueues/wp/widgets/custom-html.js')
-rw-r--r-- | src/js/_enqueues/wp/widgets/custom-html.js | 24 |
1 files changed, 12 insertions, 12 deletions
diff --git a/src/js/_enqueues/wp/widgets/custom-html.js b/src/js/_enqueues/wp/widgets/custom-html.js index 93aa901c2f..3e8d923dad 100644 --- a/src/js/_enqueues/wp/widgets/custom-html.js +++ b/src/js/_enqueues/wp/widgets/custom-html.js @@ -44,7 +44,7 @@ wp.customHtmlWidgets = ( function( $ ) { * @param {jQuery} options.el - Control field container element. * @param {jQuery} options.syncContainer - Container element where fields are synced for the server. * - * @returns {void} + * @return {void} */ initialize: function initialize( options ) { var control = this; @@ -97,7 +97,7 @@ wp.customHtmlWidgets = ( function( $ ) { * A field will only be updated if it is not currently focused, to avoid * overwriting content that the user is entering. * - * @returns {void} + * @return {void} */ updateFields: function updateFields() { var control = this, syncInput; @@ -123,7 +123,7 @@ wp.customHtmlWidgets = ( function( $ ) { * Show linting error notice. * * @param {Array} errorAnnotations - Error annotations. - * @returns {void} + * @return {void} */ updateErrorNotice: function( errorAnnotations ) { var control = this, errorNotice, message = '', customizeSetting; @@ -164,7 +164,7 @@ wp.customHtmlWidgets = ( function( $ ) { /** * Initialize editor. * - * @returns {void} + * @return {void} */ initializeEditor: function initializeEditor() { var control = this, settings; @@ -180,7 +180,7 @@ wp.customHtmlWidgets = ( function( $ ) { * * @ignore * - * @returns {void} + * @return {void} */ onTabPrevious: function onTabPrevious() { control.fields.title.focus(); @@ -191,7 +191,7 @@ wp.customHtmlWidgets = ( function( $ ) { * * @ignore * - * @returns {void} + * @return {void} */ onTabNext: function onTabNext() { var tabbables = control.syncContainer.add( control.syncContainer.parent().find( '.widget-position, .widget-control-actions' ) ).find( ':tabbable' ); @@ -204,7 +204,7 @@ wp.customHtmlWidgets = ( function( $ ) { * @ignore * * @param {Array} errorAnnotations - Error notifications. - * @returns {void} + * @return {void} */ onChangeLintingErrors: function onChangeLintingErrors( errorAnnotations ) { control.currentErrorAnnotations = errorAnnotations; @@ -216,7 +216,7 @@ wp.customHtmlWidgets = ( function( $ ) { * @ignore * * @param {Array} errorAnnotations - Error annotations. - * @returns {void} + * @return {void} */ onUpdateErrorNotice: function onUpdateErrorNotice( errorAnnotations ) { control.saveButton.toggleClass( 'validation-blocked disabled', errorAnnotations.length > 0 ); @@ -288,7 +288,7 @@ wp.customHtmlWidgets = ( function( $ ) { * @param {jQuery.Event} event - Event. * @param {jQuery} widgetContainer - Widget container element. * - * @returns {void} + * @return {void} */ component.handleWidgetAdded = function handleWidgetAdded( event, widgetContainer ) { var widgetForm, idBase, widgetControl, widgetId, animatedCheckDelay = 50, renderWhenAnimationDone, fieldContainer, syncContainer; @@ -347,7 +347,7 @@ wp.customHtmlWidgets = ( function( $ ) { * * @alias wp.customHtmlWidgets.setupAccessibleMode * - * @returns {void} + * @return {void} */ component.setupAccessibleMode = function setupAccessibleMode() { var widgetForm, idBase, widgetControl, fieldContainer, syncContainer; @@ -384,7 +384,7 @@ wp.customHtmlWidgets = ( function( $ ) { * * @param {jQuery.Event} event - Event. * @param {jQuery} widgetContainer - Widget container element. - * @returns {void} + * @return {void} */ component.handleWidgetUpdated = function handleWidgetUpdated( event, widgetContainer ) { var widgetForm, widgetId, widgetControl, idBase; @@ -415,7 +415,7 @@ wp.customHtmlWidgets = ( function( $ ) { * * @param {object} settings - Options for code editor, exported from PHP. * - * @returns {void} + * @return {void} */ component.init = function init( settings ) { var $document = $( document ); |