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/models/attachment.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/models/attachment.js')
-rw-r--r-- | src/js/media/models/attachment.js | 12 |
1 files changed, 6 insertions, 6 deletions
diff --git a/src/js/media/models/attachment.js b/src/js/media/models/attachment.js index 38f55187ad..cd29d2f98e 100644 --- a/src/js/media/models/attachment.js +++ b/src/js/media/models/attachment.js @@ -18,7 +18,7 @@ Attachment = Backbone.Model.extend(/** @lends wp.media.model.Attachment.prototyp * @param {wp.media.model.Attachment} model * @param {Object} [options={}] * - * @returns {Promise} + * @return {Promise} */ sync: function( method, model, options ) { // If the attachment does not yet have an `id`, return an instantly @@ -100,8 +100,8 @@ Attachment = Backbone.Model.extend(/** @lends wp.media.model.Attachment.prototyp * Convert date strings into Date objects. * * @param {Object} resp The raw response object, typically returned by fetch() - * @returns {Object} The modified response object, which is the attributes hash - * to be set on the model. + * @return {Object} The modified response object, which is the attributes hash + * to be set on the model. */ parse: function( resp ) { if ( ! resp ) { @@ -118,7 +118,7 @@ Attachment = Backbone.Model.extend(/** @lends wp.media.model.Attachment.prototyp * * @this Backbone.Model * - * @returns {Promise} + * @return {Promise} */ saveCompat: function( data, options ) { var model = this; @@ -143,7 +143,7 @@ Attachment = Backbone.Model.extend(/** @lends wp.media.model.Attachment.prototyp * @static * * @param {Object} attrs - * @returns {wp.media.model.Attachment} + * @return {wp.media.model.Attachment} */ create: function( attrs ) { var Attachments = wp.media.model.Attachments; @@ -158,7 +158,7 @@ Attachment = Backbone.Model.extend(/** @lends wp.media.model.Attachment.prototyp * @static * @param {string} id A string used to identify a model. * @param {Backbone.Model|undefined} attachment - * @returns {wp.media.model.Attachment} + * @return {wp.media.model.Attachment} */ get: _.memoize( function( id, attachment ) { var Attachments = wp.media.model.Attachments; |