Ticket #29157: 29157.2.diff

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

@@ -3 +3 @@
         var api = wp.customize;
 
         /**
+         * @constructor
+         * @augments wp.customize.Value
+         * @augments wp.customize.Class
+         *
          * @param options
          * - previewer - The Previewer instance to sync with.
          * - transport - The transport to use for previewing. Supports 'refresh' and 'postMessage'.
@@ -26 +30 @@
                 }
         });
 
+        /**
+         * @constructor
+         * @augments wp.customize.Class
+         */
         api.Control = api.Class.extend({
                 initialize: function( id, options ) {
                         var control = this,
@@ -87 +95 @@
                         control.toggle( control.active() );
                 },
 
+                /**
+                 * @abstract
+                 */
                 ready: function() {},
 
                 /**
@@ -141 +152 @@
                 }
         });
 
+        /**
+         * @constructor
+         * @augments wp.customize.Control
+         * @augments wp.customize.Class
+         */
         api.ColorControl = api.Control.extend({
                 ready: function() {
                         var control = this,
@@ -157 +173 @@
                 }
         });
 
+        /**
+         * @constructor
+         * @augments wp.customize.Control
+         * @augments wp.customize.Class
+         */
         api.UploadControl = api.Control.extend({
                 ready: function() {
                         var control = this;
@@ -210 +231 @@
                 }
         });
 
+        /**
+         * @constructor
+         * @augments wp.customize.UploadControl
+         * @augments wp.customize.Control
+         * @augments wp.customize.Class
+         */
         api.ImageControl = api.UploadControl.extend({
                 ready: function() {
                         var control = this,
@@ -328 +355 @@
                 }
         });
 
+        /**
+         * @constructor
+         * @augments wp.customize.Control
+         * @augments wp.customize.Class
+         */
         api.HeaderControl = api.Control.extend({
                 ready: function() {
                         this.btnRemove        = $('#customize-control-header_image .actions .remove');
@@ -544 +576 @@
         // Create the collection of Control objects.
         api.control = new api.Values({ defaultConstructor: api.Control });
 
+        /**
+         * @constructor
+         * @augments wp.customize.Messenger
+         * @augments wp.customize.Class
+         * @mixes wp.customize.Events
+         */
         api.PreviewFrame = api.Messenger.extend({
                 sensitivity: 2000,
 
@@ -714 +752 @@
 
         (function(){
                 var uuid = 0;
+                /**
+                 * Create a universally unique identifier.
+                 *
+                 * @return {int}
+                 */
                 api.PreviewFrame.uuid = function() {
                         return 'preview-' + uuid++;
                 };
         }());
 
+        /**
+         * @constructor
+         * @augments wp.customize.Messenger
+         * @augments wp.customize.Class
+         * @mixes wp.customize.Events
+         */
         api.Previewer = api.Messenger.extend({
                 refreshBuffer: 250,
 
@@ -924 +973 @@
                 }
         });
 
-        /* =====================================================================
-         * Ready.
-         * ===================================================================== */
-
         api.controlConstructor = {
                 color:  api.ColorControl,
                 upload: api.UploadControl,

src/wp-includes/class-wp-customize-manager.php

@@ -16 +16 @@
  */
 final class WP_Customize_Manager {
         /**
-         * An instance of the theme that is being customized.
+         * An instance of the theme being previewed.
          *
          * @var WP_Theme
          */
@@ -30 +30 @@
         protected $original_stylesheet;
 
         /**
-         * Whether filters have been set to change the active theme to the theme being
-         * customized.
+         * Whether this is a Customizer pageload.
          *
          * @var boolean
          */
@@ -183 +182 @@
                                 $this->wp_die( -1 );
                 }
 
-                // All good, let's do some internal business to preview the theme.
                 $this->start_previewing_theme();
         }
 
@@ -200 +198 @@
         }
 
         /**
-         * Start previewing the selected theme by adding filters to change the current theme.
+         * If the theme to be previewed isn't the active theme, add filter callbacks
+         * to swap it out at runtime.
          *
          * @since 3.4.0
          */

src/wp-includes/js/customize-preview.js

@@ -2 +2 @@
         var api = wp.customize,
                 debounce;
 
+        /**
+         * Returns a debounced version of the function.
+         *
+         * @todo Require Underscore.js for this file and retire this.
+         */
         debounce = function( fn, delay, context ) {
                 var timeout;
                 return function() {
@@ -17 +22 @@
                 };
         };
 
+        /**
+         * @constructor
+         * @augments wp.customize.Messenger
+         * @augments wp.customize.Class
+         * @mixes wp.customize.Events
+         */
         api.Preview = api.Messenger.extend({
                 /**
                  * Requires params: