Changeset 28989

Timestamp:

07/04/2014 01:42:27 AM (12 years ago)

Author:

wonderboymusic

Message:

Add more docs for media.view.MediaFrame.Select methods.

Props ericlewis.
See #28459.

File:

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

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

@@ -2141 +2141 @@
         },
 
+        /**
+         * Attach a selection collection to the frame.
+         *
+         * A selection is a collection of attachments used for a specific purpose
+         * by a media frame. e.g. Selecting an attachment (or many) to insert into
+         * post content.
+         *
+         * @see media.model.Selection
+         */
         createSelection: function() {
             var selection = this.options.selection;
@@ -2156 +2165 @@
         },
 
+        /**
+         * Create the default states on the frame.
+         */
         createStates: function() {
             var options = this.options;
@@ -2175 +2187 @@
         },
 
+        /**
+         * Bind region mode event callbacks.
+         *
+         * @see media.controller.Region.render
+         */
         bindHandlers: function() {
             this.on( 'router:create:browse', this.createRouter, this );
@@ -2183 +2200 @@
         },
 
-        // Routers
-        browseRouter: function( view ) {
-            view.set({
+        /**
+         * Render callback for the router region in the `browse` mode.
+         *
+         * @param {wp.media.view.Router} routerView
+         */
+        browseRouter: function( routerView ) {
+            routerView.set({
                 upload: {
                     text:     l10n.uploadFilesTitle,
@@ -2198 +2219 @@
 
         /**
-         * Content
+         * Render callback for the content region in the `browse` mode.
          *
-         * @param {Object} content
-         * @this wp.media.controller.Region
-         */
-        browseContent: function( content ) {
+         * @param {wp.media.controller.Region} contentRegion
+         */
+        browseContent: function( contentRegion ) {
             var state = this.state();
 
@@ -2209 +2229 @@
 
             // Browse our library of attachments.
-            content.view = new media.view.AttachmentsBrowser({
+            contentRegion.view = new media.view.AttachmentsBrowser({
                 controller: this,
                 collection: state.get('library'),
@@ -2228 +2248 @@
 
         /**
-         *
-         * @this wp.media.controller.Region
+         * Render callback for the content region in the `upload` mode.
          */
         uploadContent: function() {
-            this.$el.removeClass('hide-toolbar');
+            this.$el.removeClass( 'hide-toolbar' );
             this.content.set( new media.view.UploaderInline({
                 controller: this