Ticket #26870: 26870-media-views-02.patch

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

@@ -297 +297 @@
         /**
          * wp.media.controller.State
          *
+         * A state is a step in a workflow that when set will trigger
+         * the controllers for the regions to be updated as specified. This
+         * class is the base class that the various states used in the media
+         * modals extend.
+         *
          * @constructor
          * @augments Backbone.Model
          */
@@ -792 +797 @@
                         if ( ! this.get('AttachmentView') ) {
                                 this.set( 'AttachmentView', media.view.Attachment.EditLibrary );
                         }
-                        /**
-                         * call 'initialize' directly on the parent class
-                         */
+
                         media.controller.Library.prototype.initialize.apply( this, arguments );
                 },
 
@@ -808 +811 @@
                         this.get('library').observe( wp.Uploader.queue );
 
                         this.frame.on( 'content:render:browse', this.gallerySettings, this );
-                        /**
-                         * call 'activate' directly on the parent class
-                         */
+
                         media.controller.Library.prototype.activate.apply( this, arguments );
                 },
 
@@ -819 +820 @@
                         this.get('library').unobserve( wp.Uploader.queue );
 
                         this.frame.off( 'content:render:browse', this.gallerySettings, this );
-                        /**
-                         * call 'deactivate' directly on the parent class
-                         */
+
                         media.controller.Library.prototype.deactivate.apply( this, arguments );
                 },
 
@@ -886 +885 @@
                         if ( ! this.get('library') ) {
                                 this.set( 'library', media.query({ type: 'image' }) );
                         }
-                        /**
-                         * call 'initialize' directly on the parent class
-                         */
                         media.controller.Library.prototype.initialize.apply( this, arguments );
                 },
 
@@ -903 +899 @@
                         // Accepts attachments that exist in the original library and
                         // that do not exist in gallery's library.
                         library.validator = function( attachment ) {
-                                return !! this.mirroring.get( attachment.cid )
-                                        && ! edit.get( attachment.cid )
-                                        /**
-                                         * call 'validator' directly on wp.media.model.Selection
-                                         */
-                                        && media.model.Selection.prototype.validator.apply( this, arguments );
+                                return !! this.mirroring.get( attachment.cid ) && ! edit.get( attachment.cid ) &&
+                                        media.model.Selection.prototype.validator.apply( this, arguments );
                         };
 
                         // Reset the library to ensure that all attachments are re-added
@@ -917 +909 @@
                         library.reset( library.mirroring.models, { silent: true });
                         library.observe( edit );
                         this.editLibrary = edit;
-                        /**
-                         * call 'activate' directly on the parent class
-                         */
+
                         media.controller.Library.prototype.activate.apply( this, arguments );
                 }
         });
@@ -950 +940 @@
                         if ( ! this.get('library') ) {
                                 this.set( 'library', media.query({ type: 'image' }) );
                         }
-                        /**
-                         * call 'initialize' directly on the parent class
-                         */
+
                         media.controller.Library.prototype.initialize.apply( this, arguments );
 
                         library    = this.get('library');
@@ -981 +969 @@
                 activate: function() {
                         this.updateSelection();
                         this.frame.on( 'open', this.updateSelection, this );
-                        /**
-                         * call 'activate' directly on the parent class
-                         */
+
                         media.controller.Library.prototype.activate.apply( this, arguments );
                 },
 
                 deactivate: function() {
                         this.frame.off( 'open', this.updateSelection, this );
-                        /**
-                         * call 'deactivate' directly on the parent class
-                         */
+
                         media.controller.Library.prototype.deactivate.apply( this, arguments );
                 },
 
@@ -1038 +1022 @@
                         if ( ! this.get('library') ) {
                                 this.set( 'library', media.query({ type: 'image' }) );
                         }
-                        /**
-                         * call 'initialize' directly on the parent class
-                         */
+
                         media.controller.Library.prototype.initialize.apply( this, arguments );
 
                         library    = this.get('library');
@@ -1068 +1050 @@
 
                 activate: function() {
                         this.updateSelection();
-                        /**
-                         * call 'activate' directly on the parent class
-                         */
                         media.controller.Library.prototype.activate.apply( this, arguments );
                 },
 
-                deactivate: function() {
-                        /**
-                         * call 'deactivate' directly on the parent class
-                         */
-                        media.controller.Library.prototype.deactivate.apply( this, arguments );
-                },
-
                 updateSelection: function() {
                         var selection = this.get('selection'),
                                 attachment = this.image.attachment;
@@ -1268 +1240 @@
         /**
          * wp.media.view.Frame
          *
+         * A frame is a composite view consisting of one or more regions and one or more
+         * states. Only one state can be active at any given moment.
+         *
          * @constructor
          * @augments wp.media.View
          * @augments wp.Backbone.View
@@ -1327 +1302 @@
         /**
          * wp.media.view.MediaFrame
          *
+         * Type of frame used to create the media modal.
+         *
          * @constructor
          * @augments wp.media.view.Frame
          * @augments wp.media.View
@@ -1343 +1320 @@
                  * @global wp.Uploader
                  */
                 initialize: function() {
-                        /**
-                         * call 'initialize' directly on the parent class
-                         */
+
                         media.view.Frame.prototype.initialize.apply( this, arguments );
 
                         _.defaults( this.options, {
@@ -1550 +1525 @@
         /**
          * wp.media.view.MediaFrame.Select
          *
+         * Type of media frame that is used to select an item or items from the media library
+         *
          * @constructor
          * @augments wp.media.view.MediaFrame
          * @augments wp.media.view.Frame