Changeset 42410

Timestamp:

12/18/2017 11:19:02 AM (7 years ago)

Author:

atimmer

Message:

Docs: Improve JSDoc for js/media/controllers/edit-image.js.

Amends r42392 - includes the built media files.

File:

• trunk/src/wp-includes/js/media-views.js (modified) (4 diffs)

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

@@ -2046 +2046 @@
 
     /**
+     * Activates a frame for editing a featured image.
+     *
      * @since 3.9.0
+     *
+     * @returns {void}
      */
     activate: function() {
@@ -2053 +2057 @@
 
     /**
+     * Deactivates a frame for editing a featured image.
+     *
      * @since 3.9.0
+     *
+     * @returns {void}
      */
     deactivate: function() {
@@ -2060 +2068 @@
 
     /**
+     * Adds a toolbar with a back button.
+     *
+     * When the back button is pressed it checks whether there is a previous state.
+     * In case there is a previous state it sets that previous state otherwise it
+     * closes the frame.
+     *
      * @since 3.9.0
+     *
+     * @returns {void}
      */
     toolbar: function() {
@@ -3726 +3742 @@
 
             /**
-             * @callback
+             * @ignore
+             *
              * @fires wp.media.controller.State#insert
              */