diff --git a/src/wp-includes/js/media-views.js b/src/wp-includes/js/media-views.js index c9c3a8af3e..60ad65ee48 100644 --- a/src/wp-includes/js/media-views.js +++ b/src/wp-includes/js/media-views.js @@ -2487,18 +2487,28 @@ var Controller = wp.media.controller, CustomizeImageCropper; /** - * wp.media.controller.CustomizeImageCropper + * A state for cropping an image in the customizer. * + * @since 4.3.0 + * + * @constructs wp.media.controller.CustomizeImageCropper * @memberOf wp.media.controller - * - * A state for cropping an image. - * - * @class - * @augments wp.media.controller.Cropper - * @augments wp.media.controller.State - * @augments Backbone.Model + * @augments wp.media.controller.CustomizeImageCropper.Cropper + * @inheritDoc */ CustomizeImageCropper = Controller.Cropper.extend(/** @lends wp.media.controller.CustomizeImageCropper.prototype */{ + /** + * Posts the crop details to the admin. + * + * Uses crop measurements when flexible in both directions. + * Constrains flexible side based on image ratio and size of the fixed side. + * + * @since 4.3.0 + * + * @param {Object} attachment The attachment to crop. + * + * @returns {$.promise} A jQuery promise that represents the crop image request. + */ doCrop: function( attachment ) { var cropDetails = attachment.get( 'cropDetails' ), control = this.get( 'control' ), diff --git a/src/wp-includes/js/media/controllers/customize-image-cropper.js b/src/wp-includes/js/media/controllers/customize-image-cropper.js index 5f076178ec..a9c2e9fc90 100644 --- a/src/wp-includes/js/media/controllers/customize-image-cropper.js +++ b/src/wp-includes/js/media/controllers/customize-image-cropper.js @@ -2,18 +2,28 @@ var Controller = wp.media.controller, CustomizeImageCropper; /** - * wp.media.controller.CustomizeImageCropper + * A state for cropping an image in the customizer. * + * @since 4.3.0 + * + * @constructs wp.media.controller.CustomizeImageCropper * @memberOf wp.media.controller - * - * A state for cropping an image. - * - * @class - * @augments wp.media.controller.Cropper - * @augments wp.media.controller.State - * @augments Backbone.Model + * @augments wp.media.controller.CustomizeImageCropper.Cropper + * @inheritDoc */ CustomizeImageCropper = Controller.Cropper.extend(/** @lends wp.media.controller.CustomizeImageCropper.prototype */{ + /** + * Posts the crop details to the admin. + * + * Uses crop measurements when flexible in both directions. + * Constrains flexible side based on image ratio and size of the fixed side. + * + * @since 4.3.0 + * + * @param {Object} attachment The attachment to crop. + * + * @returns {$.promise} A jQuery promise that represents the crop image request. + */ doCrop: function( attachment ) { var cropDetails = attachment.get( 'cropDetails' ), control = this.get( 'control' ),