Ticket #33503: 33503.3.diff

src/wp-admin/js/customize-controls.js

@@ -270 +270 @@
                 },
 
                 /**
-                 * Handle changes to the active state.
+                 * Active state change handler.
                  *
-                 * This does not change the active state, it merely handles the behavior
-                 * for when it does change.
+                 * Shows the container if it is active, hides it if not.
                  *
                  * To override by subclass, update the container's UI to reflect the provided active state.
                  *
@@ -2573 +2572 @@
         api.panel = new api.Values({ defaultConstructor: api.Panel });
 
         /**
+         * An object that fetches a preview in the background of the document, which
+         * allows for seamless replacement of an existing preview.
+         *
          * @class
          * @augments wp.customize.Messenger
          * @augments wp.customize.Class
@@ -2581 +2583 @@
         api.PreviewFrame = api.Messenger.extend({
                 sensitivity: 2000,
 
+                /**
+                 * Initialize the PreviewFrame.
+                 *
+                 * @param {object} params.container
+                 * @param {object} params.signature
+                 * @param {object} params.previewUrl
+                 * @param {object} params.query
+                 * @param {object} options
+                 */
                 initialize: function( params, options ) {
                         var deferred = $.Deferred();
 
-                        // This is the promise object.
+                        /*
+                         * Make the instance of the PreviewFrame the promise object
+                         * so other objects can easily interact with it.
+                         */
                         deferred.promise( this );
 
                         this.container = params.container;
@@ -2601 +2615 @@
                         this.run( deferred );
                 },
 
+                /**
+                 * Run the preview request.
+                 *
+                 * @param {object} deferred jQuery Deferred object to be resolved with
+                 *                          the request.
+                 */
                 run: function( deferred ) {
                         var self   = this,
                                 loaded = false,
@@ -2928 +2948 @@
                         }
                 },
 
+                /**
+                 * Refresh the preview.
+                 */
                 refresh: function() {
                         var self = this;