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/media/controllers/region.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/media/controllers/region.js')
| -rw-r--r-- | src/js/media/controllers/region.js | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/src/js/media/controllers/region.js b/src/js/media/controllers/region.js index 0973e68d0c..26d47808e6 100644 --- a/src/js/media/controllers/region.js +++ b/src/js/media/controllers/region.js @@ -38,7 +38,7 @@ _.extend( Region.prototype,/** @lends wp.media.controller.Region.prototype */{ * @fires Region#activate * @fires Region#deactivate * - * @returns {wp.media.controller.Region} Returns itself to allow chaining. + * @return {wp.media.controller.Region} Returns itself to allow chaining. */ mode: function( mode ) { if ( ! mode ) { @@ -77,7 +77,7 @@ _.extend( Region.prototype,/** @lends wp.media.controller.Region.prototype */{ * @fires Region#create * @fires Region#render * - * @returns {wp.media.controller.Region} Returns itself to allow chaining. + * @return {wp.media.controller.Region} Returns itself to allow chaining. */ render: function( mode ) { // If the mode isn't active, activate it. @@ -120,7 +120,7 @@ _.extend( Region.prototype,/** @lends wp.media.controller.Region.prototype */{ * * @since 3.5.0 * - * @returns {wp.media.View} + * @return {wp.media.View} */ get: function() { return this.view.views.first( this.selector ); @@ -133,7 +133,7 @@ _.extend( Region.prototype,/** @lends wp.media.controller.Region.prototype */{ * * @param {Array|Object} views * @param {Object} [options={}] - * @returns {wp.Backbone.Subviews} Subviews is returned to allow chaining. + * @return {wp.Backbone.Subviews} Subviews is returned to allow chaining. */ set: function( views, options ) { if ( options ) { @@ -148,7 +148,7 @@ _.extend( Region.prototype,/** @lends wp.media.controller.Region.prototype */{ * @since 3.5.0 * * @param {string} event - * @returns {undefined|wp.media.controller.Region} Returns itself to allow chaining. + * @return {undefined|wp.media.controller.Region} Returns itself to allow chaining. */ trigger: function( event ) { var base, args; |