Changeset 43141

Timestamp:

05/03/2018 02:39:25 PM (8 years ago)

Author:

atimmer

Message:

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

Props Xyfi, nataliashitova, igorsch, ireneyoast, manuelaugustin.
Fixes #43866.

File:

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

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

@@ -17 +17 @@
  * @memberOf wp.media.controller
  *
- * @param {object}                     [attributes]                       The attributes hash passed to the state.
+ * @param {Object}                     [attributes]                       The attributes hash passed to the state.
  * @param {string}                     [attributes.id=gallery-edit]       Unique identifier.
  * @param {string}                     [attributes.title=Edit Gallery]    Title for the state. Displays in the frame's title region.
@@ -60 +60 @@
 
         /**
+         * Initializes the library.
+         *
+         * Creates a selection if a library isn't supplied and creates an attachment
+         * view if no attachment view is supplied.
+         *
          * @since 3.5.0
+         *
+         * @return {void}
          */
         initialize: function() {
@@ -77 +84 @@
 
         /**
+         * Activates the library.
+         *
+         * Limits the library to images, watches for uploaded attachments. Watches for
+         * the browse event on the frame and binds it to gallerySettings.
+         *
          * @since 3.5.0
+         *
+         * @return {void}
          */
         activate: function() {
@@ -94 +108 @@
 
         /**
+         * Deactivates the library.
+         *
+         * Stops watching for uploaded attachments and browse events.
+         *
          * @since 3.5.0
+         *
+         * @return {void}
          */
         deactivate: function() {
@@ -106 +126 @@
 
         /**
+         * Adds the gallery settings to the sidebar and adds a reverse button to the
+         * toolbar.
+         *
          * @since 3.5.0
          *
-         * @param browser
+         * @param {wp.media.view.Frame} browser The file browser.
+         *
+         * @return {void}
          */
         gallerySettings: function( browser ) {