Docs: Improve JS Docs for controllers/customize-image-cropper.js.

Props manuelaugustin, bramheijmink, andizer, ireneyoast.
Fixes #43020.

Built from https://develop.svn.wordpress.org/trunk@42435


git-svn-id: http://core.svn.wordpress.org/trunk@42265 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
atimmer 2018-01-11 14:32:52 +00:00
parent 1d59873ace
commit 6310ad30d0
2 changed files with 19 additions and 9 deletions

View File

@ -2487,18 +2487,28 @@ var Controller = wp.media.controller,
CustomizeImageCropper; 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 * @memberOf wp.media.controller
* * @augments wp.media.controller.CustomizeImageCropper.Cropper
* A state for cropping an image. * @inheritDoc
*
* @class
* @augments wp.media.controller.Cropper
* @augments wp.media.controller.State
* @augments Backbone.Model
*/ */
CustomizeImageCropper = Controller.Cropper.extend(/** @lends wp.media.controller.CustomizeImageCropper.prototype */{ 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 ) { doCrop: function( attachment ) {
var cropDetails = attachment.get( 'cropDetails' ), var cropDetails = attachment.get( 'cropDetails' ),
control = this.get( 'control' ), control = this.get( 'control' ),

View File

@ -4,7 +4,7 @@
* *
* @global string $wp_version * @global string $wp_version
*/ */
$wp_version = '5.0-alpha-42433'; $wp_version = '5.0-alpha-42435';
/** /**
* Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema. * Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.