Changeset 29451

Timestamp:

08/08/2014 11:30:30 PM (10 years ago)

Author:

wonderboymusic

Message:

Add some docs to Customizer JS.

Props ericlewis.
See #29157.

Location:

trunk/src

Files:

• wp-admin/js/customize-controls.js (modified) (11 diffs)
• wp-includes/class-wp-customize-manager.php (modified) (4 diffs)
• wp-includes/js/customize-preview.js (modified) (2 diffs)

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

@@ -4 +4 @@
 
     /**
+     * @constructor
+     * @augments wp.customize.Value
+     * @augments wp.customize.Class
+     *
      * @param options
      * - previewer - The Previewer instance to sync with.
@@ -27 +31 @@
     });
 
+    /**
+     * @constructor
+     * @augments wp.customize.Class
+     */
     api.Control = api.Class.extend({
         initialize: function( id, options ) {
@@ -88 +96 @@
         },
 
+        /**
+         * @abstract
+         */
         ready: function() {},
 
@@ -142 +153 @@
     });
 
+    /**
+     * @constructor
+     * @augments wp.customize.Control
+     * @augments wp.customize.Class
+     */
     api.ColorControl = api.Control.extend({
         ready: function() {
@@ -158 +174 @@
     });
 
+    /**
+     * @constructor
+     * @augments wp.customize.Control
+     * @augments wp.customize.Class
+     */
     api.UploadControl = api.Control.extend({
         ready: function() {
@@ -211 +232 @@
     });
 
+    /**
+     * @constructor
+     * @augments wp.customize.UploadControl
+     * @augments wp.customize.Control
+     * @augments wp.customize.Class
+     */
     api.ImageControl = api.UploadControl.extend({
         ready: function() {
@@ -329 +356 @@
     });
 
+    /**
+     * @constructor
+     * @augments wp.customize.Control
+     * @augments wp.customize.Class
+     */
     api.HeaderControl = api.Control.extend({
         ready: function() {
@@ -545 +577 @@
     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,
@@ -715 +753 @@
     (function(){
         var uuid = 0;
+        /**
+         * Create a universally unique identifier.
+         *
+         * @return {int}
+         */
         api.PreviewFrame.uuid = function() {
             return 'preview-' + uuid++;
@@ -720 +763 @@
     }());
 
+    /**
+     * @constructor
+     * @augments wp.customize.Messenger
+     * @augments wp.customize.Class
+     * @mixes wp.customize.Events
+     */
     api.Previewer = api.Messenger.extend({
         refreshBuffer: 250,
@@ -925 +974 @@
     });
 
-    /* =====================================================================
-     * Ready.
-     * ===================================================================== */
-
     api.controlConstructor = {
         color:  api.ColorControl,

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

@@ -17 +17 @@
 final class WP_Customize_Manager {
     /**
-     * An instance of the theme that is being customized.
+     * An instance of the theme being previewed.
      *
      * @var WP_Theme
@@ -31 +31 @@
 
     /**
-     * Whether filters have been set to change the active theme to the theme being
-     * customized.
+     * Whether this is a Customizer pageload.
      *
      * @var boolean
@@ -184 +183 @@
         }
 
-        // All good, let's do some internal business to preview the theme.
         $this->start_previewing_theme();
     }
@@ -201 +199 @@
 
     /**
-     * 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

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

@@ -3 +3 @@
         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;
@@ -18 +23 @@
     };
 
+    /**
+     * @constructor
+     * @augments wp.customize.Messenger
+     * @augments wp.customize.Class
+     * @mixes wp.customize.Events
+     */
     api.Preview = api.Messenger.extend({
         /**