sergiotarxz/Wordpress
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

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

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


git-svn-id: https://develop.svn.wordpress.org/trunk@42435 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Anton Timmermans 2018-01-11 14:31:14 +00:00
parent 91b3164ee5
commit b9b2f2a79d
2 changed files with 36 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
src/wp-includes/js/media-views.js
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' ),

26
src/wp-includes/js/media/controllers/customize-image-cropper.js
View File

@ -2,18 +2,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' ),