Changeset 45561

Timestamp:

06/22/2019 01:01:22 PM (5 years ago)

Author:

atimmer

Message:

Docs: Improve JSDoc for media/views/attachment/details.js.

Props maartenleenders, boblinthorst, dfangstrom.
Fixes #47588.

File:

• trunk/src/js/media/views/attachment/details.js (modified) (7 diffs)

trunk/src/js/media/views/attachment/details.js

@@ -4 +4 @@
     Details;
 
-/**
- * wp.media.view.Attachment.Details
- *
- * @memberOf wp.media.view.Attachment
- *
- * @class
- * @augments wp.media.view.Attachment
- * @augments wp.media.View
- * @augments wp.Backbone.View
- * @augments Backbone.View
- */
 Details = Attachment.extend(/** @lends wp.media.view.Attachment.Details.prototype */{
     tagName:   'div',
@@ -38 +27 @@
     },
 
+    /**
+     * Shows the details of an attachment.
+     *
+     * @since 3.5.0
+     *
+     * @constructs wp.media.view.Attachment.Details
+     * @augments wp.media.view.Attachment
+     *
+     * @returns {void}
+     */
     initialize: function() {
         this.options = _.defaults( this.options, {
@@ -99 +98 @@
 
     /**
-     * @param {Object} event
+     * Deletes an attachment.
+     *
+     * Deletes an attachment after asking for confirmation. After deletion,
+     * keeps focus in the modal.
+     *
+     * @since 3.5.0
+     *
+     * @param {MouseEvent} event A click event.
+     *
+     * @returns {void}
      */
     deleteAttachment: function( event ) {
@@ -111 +119 @@
         }
     },
-    /**
-     * @param {Object} event
+
+    /**
+     * Sets the trash state on an attachment, or destroys the model itself.
+     *
+     * If the mediaTrash setting is set to true, trashes the attachment.
+     * Otherwise, the model itself is destroyed.
+     *
+     * @since 3.9.0
+     *
+     * @param {MouseEvent} event A click event.
+     *
+     * @returns {void}
      */
     trashAttachment: function( event ) {
@@ -142 +160 @@
     },
     /**
-     * @param {Object} event
+     * Untrashes an attachment.
+     *
+     * @since 4.0.0
+     *
+     * @param {MouseEvent} event A click event.
+     *
+     * @returns {void}
      */
     untrashAttachment: function( event ) {
@@ -153 +177 @@
         } );
     },
-    /**
-     * @param {Object} event
+
+    /**
+     * Opens the edit page for a specific attachment.
+     *
+     * @since 3.5.0
+     *
+     * @param {MouseEvent} event A click event.
+     *
+     * @returns {void}
      */
     editAttachment: function( event ) {
@@ -167 +198 @@
         }
     },
-    /**
-     * When reverse tabbing (shift+tab) out of the right details panel,
-     * move focus to the item that was being edited in the attachments list.
-     *
-     * @param {Object} event
+
+    /**
+     * Triggers an event on the controller when reverse tabbing (shift+tab).
+     *
+     * This event can be used to make sure to move the focus correctly.
+     *
+     * @since 4.0.0
+     *
+     * @fires wp.media.controller.MediaLibrary#attachment:details:shift-tab
+     * @fires wp.media.controller.MediaLibrary#attachment:keydown:arrow
+     *
+     * @param {KeyboardEvent} event A keyboard event.
+     *
+     * @returns {boolean|void} Returns false or undefined.
      */
     toggleSelectionHandler: function( event ) {