Changeset 42392 for trunk

Timestamp:

12/13/2017 02:09:45 PM (9 years ago)

Author:

atimmer

Message:

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

Props jjcomack, nicollle, andizer.
Fixes #42680.

File:

• trunk/src/wp-includes/js/media/controllers/edit-image.js (modified) (3 diffs)

trunk/src/wp-includes/js/media/controllers/edit-image.js

@@ -33 +33 @@
 
         /**
+         * Activates a frame for editing a featured image.
+         *
          * @since 3.9.0
+         *
+         * @returns {void}
          */
         activate: function() {
@@ -40 +44 @@
 
         /**
+         * Deactivates a frame for editing a featured image.
+         *
          * @since 3.9.0
+         *
+         * @returns {void}
          */
         deactivate: function() {
@@ -47 +55 @@
 
         /**
+         * 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() {