Changeset 42435 for trunk

Timestamp:

01/11/2018 02:31:14 PM (7 years ago)

Author:

atimmer

Message:

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

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

Location:

trunk/src/wp-includes/js

Files:

• media-views.js (modified) (1 diff)
• media/controllers/customize-image-cropper.js (modified) (1 diff)

trunk/src/wp-includes/js/media-views.js

@@ -2488 +2488 @@
 
 /**
- * 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' ),

trunk/src/wp-includes/js/media/controllers/customize-image-cropper.js

@@ -3 +3 @@
 
 /**
- * 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' ),