Changeset 27126

Timestamp:

02/07/2014 08:20:38 PM (11 years ago)

Author:

wonderboymusic

Message:

Add some inline docs to media-views.js and remove some unnecessary comments from a few super calls.

Props gcorne.
See #26870.

File:

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

trunk/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
@@ -793 +798 @@
                 this.set( 'AttachmentView', media.view.Attachment.EditLibrary );
             }
-            /**
-             * call 'initialize' directly on the parent class
-             */
+
             media.controller.Library.prototype.initialize.apply( this, arguments );
         },
@@ -809 +812 @@
 
             this.frame.on( 'content:render:browse', this.gallerySettings, this );
-            /**
-             * call 'activate' directly on the parent class
-             */
+
             media.controller.Library.prototype.activate.apply( this, arguments );
         },
@@ -820 +821 @@
 
             this.frame.off( 'content:render:browse', this.gallerySettings, this );
-            /**
-             * call 'deactivate' directly on the parent class
-             */
+
             media.controller.Library.prototype.deactivate.apply( this, arguments );
         },
@@ -887 +886 @@
                 this.set( 'library', media.query({ type: 'image' }) );
             }
-            /**
-             * call 'initialize' directly on the parent class
-             */
             media.controller.Library.prototype.initialize.apply( this, arguments );
         },
@@ -904 +900 @@
             // 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 );
             };
 
@@ -918 +910 @@
             library.observe( edit );
             this.editLibrary = edit;
-            /**
-             * call 'activate' directly on the parent class
-             */
+
             media.controller.Library.prototype.activate.apply( this, arguments );
         }
@@ -951 +941 @@
                 this.set( 'library', media.query({ type: 'image' }) );
             }
-            /**
-             * call 'initialize' directly on the parent class
-             */
+
             media.controller.Library.prototype.initialize.apply( this, arguments );
 
@@ -982 +970 @@
             this.updateSelection();
             this.frame.on( 'open', this.updateSelection, this );
-            /**
-             * call 'activate' directly on the parent class
-             */
+
             media.controller.Library.prototype.activate.apply( this, arguments );
         },
@@ -990 +976 @@
         deactivate: function() {
             this.frame.off( 'open', this.updateSelection, this );
-            /**
-             * call 'deactivate' directly on the parent class
-             */
+
             media.controller.Library.prototype.deactivate.apply( this, arguments );
         },
@@ -1039 +1023 @@
                 this.set( 'library', media.query({ type: 'image' }) );
             }
-            /**
-             * call 'initialize' directly on the parent class
-             */
+
             media.controller.Library.prototype.initialize.apply( this, arguments );
 
@@ -1069 +1051 @@
         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 );
         },
 
@@ -1269 +1241 @@
      * 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
@@ -1328 +1303 @@
      * wp.media.view.MediaFrame
      *
+     * Type of frame used to create the media modal.
+     *
      * @constructor
      * @augments wp.media.view.Frame
@@ -1344 +1321 @@
          */
         initialize: function() {
-            /**
-             * call 'initialize' directly on the parent class
-             */
+
             media.view.Frame.prototype.initialize.apply( this, arguments );
 
@@ -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