enmi-conf.org: comparison wp/wp-admin/js/customize-controls.js

Mercurial Mercurial > enmi-conf.org / comparison

summary | shortlog | changelog | graph | tags | bookmarks | branches | files | changeset | file | latest | revisions | annotate | diff | comparison | raw | help

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

changeset 9	177826044cd9
parent 7	cf61fcea0001
child 16	a86126ab1dd4

equal deleted inserted replaced

-:c7c34916027a
+:177826044cd9
+/**
+* @output wp-admin/js/customize-controls.js
+*/
 /* global _wpCustomizeHeader, _wpCustomizeBackground, _wpMediaViewsL10n, MediaElementPlayer, console, confirm */
 (function( exports, $ ){
 	var Container, focus, normalizedTransitionendEventName, api = wp.customize;
-	/**
+	api.OverlayNotification = api.Notification.extend(/** @lends wp.customize.OverlayNotification.prototype */{
-	 * A notification that is displayed in a full-screen overlay.
-	 *
-	 * @since 4.9.0
-	 * @class
-	 * @augments wp.customize.Notification
-	 */
-	api.OverlayNotification = api.Notification.extend({
 		/**
 		 * Whether the notification should show a loading spinner.
 		 *
 		 * @since 4.9.0
 		 * @var {boolean}
 		 */
 		loading: false,
 		/**
-		 * Initialize.
+		 * A notification that is displayed in a full-screen overlay.
+		 *
+		 * @constructs wp.customize.OverlayNotification
+		 * @augments   wp.customize.Notification
 		 *
 		 * @since 4.9.0
 		 *
 		 * @param {string} code - Code.
 		 * @param {object} params - Params.
 				}
 			}
 		}
 	});
-	/**
+	api.Notifications = api.Values.extend(/** @lends wp.customize.Notifications.prototype */{
-	 * A collection of observable notifications.
-	 *
-	 * @since 4.9.0
-	 * @class
-	 * @augments wp.customize.Values
-	 */
-	api.Notifications = api.Values.extend({
 		/**
 		 * Whether the alternative style should be used.
 		 *
 		 * @since 4.9.0
 		 * @type {object}
 		 */
 		defaultConstructor: api.Notification,
 		/**
-		 * Initialize notifications area.
+		 * A collection of observable notifications.
 		 *
 		 * @since 4.9.0
-		 * @constructor
+		 *
+		 * @constructs wp.customize.Notifications
+		 * @augments   wp.customize.Values
+		 *
 		 * @param {object}  options - Options.
 		 * @param {jQuery}  [options.container] - Container element for notifications. This can be injected later.
 		 * @param {boolean} [options.alt] - Whether alternative style should be used when rendering notifications.
+		 *
 		 * @returns {void}
-		 * @this {wp.customize.Notifications}
 		 */
 		initialize: function( options ) {
 			var collection = this;
 			api.Values.prototype.initialize.call( collection, options );
 		 *
 		 * @since 4.9.0
 		 * @param {object}  args - Args.
 		 * @param {boolean} [args.sort=false] - Whether to return the notifications sorted.
 		 * @return {Array.<wp.customize.Notification>} Notifications.
-		 * @this {wp.customize.Notifications}
 		 */
 		get: function( args ) {
 			var collection = this, notifications, errorTypePriorities, params;
 			notifications = _.values( collection._value );
 		/**
 		 * Render notifications area.
 		 *
 		 * @since 4.9.0
 		 * @returns {void}
-		 * @this {wp.customize.Notifications}
 		 */
 		render: function() {
 			var collection = this,
 				notifications, hadOverlayNotification = false, hasOverlayNotification, overlayNotifications = [],
 				previousNotificationsByCode = {},
 				focusableElements.last().focus();
 			}
 		}
 	});
-	/**
+	api.Setting = api.Value.extend(/** @lends wp.customize.Setting.prototype */{
-	 * A Customizer Setting.
-	 *
-	 * A setting is WordPress data (theme mod, option, menu, etc.) that the user can
-	 * draft changes to in the Customizer.
-	 *
-	 * @see PHP class WP_Customize_Setting.
-	 *
-	 * @since 3.4.0
-	 * @class
-	 * @augments wp.customize.Value
-	 * @augments wp.customize.Class
-	 */
-	api.Setting = api.Value.extend({
 		/**
 		 * Default params.
 		 *
 		 * @since 4.9.0
 			transport: 'refresh',
 			dirty: false
 		},
 		/**
-		 * Initialize.
+		 * A Customizer Setting.
+		 *
+		 * A setting is WordPress data (theme mod, option, menu, etc.) that the user can
+		 * draft changes to in the Customizer.
+		 *
+		 * @see PHP class WP_Customize_Setting.
+		 *
+		 * @constructs wp.customize.Setting
+		 * @augments   wp.customize.Value
 		 *
 		 * @since 3.4.0
 		 *
 		 * @param {string}  id                          - The setting ID.
 		 * @param {*}       value                       - The initial value of the setting.
 	});
 	/**
 	 * Current change count.
 	 *
+	 * @alias wp.customize._latestRevision
+	 *
 	 * @since 4.7.0
 	 * @type {number}
 	 * @protected
 	 */
 	api._latestRevision = 0;
 	/**
 	 * Last revision that was saved.
 	 *
+	 * @alias wp.customize._lastSavedRevision
+	 *
 	 * @since 4.7.0
 	 * @type {number}
 	 * @protected
 	 */
 	api._lastSavedRevision = 0;
 	/**
 	 * Latest revisions associated with the updated setting.
+	 *
+	 * @alias wp.customize._latestSettingRevisions
 	 *
 	 * @since 4.7.0
 	 * @type {object}
 	 * @protected
 	 */
 	} );
 	/**
 	 * Get the dirty setting values.
 	 *
+	 * @alias wp.customize.dirtyValues
+	 *
 	 * @since 4.7.0
 	 * @access public
 	 *
 	 * @param {object} [options] Options.
 	 * @param {boolean} [options.unsaved=false] Whether only values not saved yet into a changeset will be returned (differential changes).
 		return values;
 	};
 	/**
 	 * Request updates to the changeset.
+	 *
+	 * @alias wp.customize.requestChangesetUpdate
 	 *
 	 * @since 4.7.0
 	 * @access public
 	 *
 	 * @param {object}  [changes] - Mapping of setting IDs to setting params each normally including a value property, or mapping to null.
 	};
 	/**
 	 * Watch all changes to Value properties, and bubble changes to parent Values instance
 	 *
+	 * @alias wp.customize.utils.bubbleChildValueChanges
+	 *
 	 * @since 4.1.0
 	 *
 	 * @param {wp.customize.Class} instance
 	 * @param {Array}              properties  The names of the Value instances to watch.
 	 */
 		} );
 	};
 	/**
 	 * Expand a panel, section, or control and focus on the first focusable element.
+	 *
+	 * @alias wp.customize~focus
 	 *
 	 * @since 4.1.0
 	 *
 	 * @param {Object}   [params]
 	 * @param {Function} [params.completeCallback]
 	/**
 	 * Stable sort for Panels, Sections, and Controls.
 	 *
 	 * If a.priority() === b.priority(), then sort by their respective params.instanceNumber.
 	 *
+	 * @alias wp.customize.utils.prioritySort
+	 *
 	 * @since 4.1.0
 	 *
 	 * @param {(wp.customize.Panel|wp.customize.Section|wp.customize.Control)} a
 	 * @param {(wp.customize.Panel|wp.customize.Section|wp.customize.Control)} b
 	 * @returns {Number}
 	};
 	/**
 	 * Return whether the supplied Event object is for a keydown event but not the Enter key.
 	 *
+	 * @alias wp.customize.utils.isKeydownButNotEnterEvent
+	 *
 	 * @since 4.1.0
 	 *
 	 * @param {jQuery.Event} event
 	 * @returns {boolean}
 	 */
 		return ( 'keydown' === event.type && 13 !== event.which );
 	};
 	/**
 	 * Return whether the two lists of elements are the same and are in the same order.
+	 *
+	 * @alias wp.customize.utils.areElementListsEqual
 	 *
 	 * @since 4.1.0
 	 *
 	 * @param {Array|jQuery} listA
 	 * @param {Array|jQuery} listB
 	 * Highlight the existence of a button.
 	 *
 	 * This function reminds the user of a button represented by the specified
 	 * UI element, after an optional delay. If the user focuses the element
 	 * before the delay passes, the reminder is canceled.
+	 *
+	 * @alias wp.customize.utils.highlightButton
 	 *
 	 * @since 4.9.0
 	 *
 	 * @param {jQuery} button - The element to highlight.
 	 * @param {object} [options] - Options.
 	/**
 	 * Get current timestamp adjusted for server clock time.
 	 *
 	 * Same functionality as the `current_time( 'mysql', false )` function in PHP.
 	 *
+	 * @alias wp.customize.utils.getCurrentTimestamp
+	 *
 	 * @since 4.9.0
 	 *
 	 * @returns {int} Current timestamp.
 	 */
 	api.utils.getCurrentTimestamp = function getCurrentTimestamp() {
 		return currentDate.getTime();
 	};
 	/**
 	 * Get remaining time of when the date is set.
+	 *
+	 * @alias wp.customize.utils.getRemainingTime
 	 *
 	 * @since 4.9.0
 	 *
 	 * @param {string|int|Date} datetime - Date time or timestamp of the future date.
 	 * @return {int} remainingTime - Remaining time in milliseconds.
 	/**
 	 * Return browser supported `transitionend` event name.
 	 *
 	 * @since 4.7.0
+	 *
+	 * @ignore
 	 *
 	 * @returns {string|null} Normalized `transitionend` event name or null if CSS transitions are not supported.
 	 */
 	normalizedTransitionendEventName = (function () {
 		var el, transitions, prop;
 		} else {
 			return null;
 		}
 	})();
-	/**
+	Container = api.Class.extend(/** @lends wp.customize~Container.prototype */{
-	 * Base class for Panel and Section.
-	 *
-	 * @since 4.1.0
-	 *
-	 * @class
-	 * @augments wp.customize.Class
-	 */
-	Container = api.Class.extend({
 		defaultActiveArguments: { duration: 'fast', completeCallback: $.noop },
 		defaultExpandedArguments: { duration: 'fast', completeCallback: $.noop },
 		containerType: 'container',
 		defaults: {
 			title: '',
 			active: true,
 			instanceNumber: null
 		},
 		/**
+		 * Base class for Panel and Section.
+		 *
+		 * @constructs wp.customize~Container
+		 * @augments   wp.customize.Class
+		 *
 		 * @since 4.1.0
 		 *
-		 * @param {string}         id - The ID for the container.
+		 * @borrows wp.customize~focus as focus
-		 * @param {object}         options - Object containing one property: params.
+		 *
-		 * @param {string}         options.title - Title shown when panel is collapsed and expanded.
+		 * @param {string}  id - The ID for the container.
-		 * @param {string=}        [options.description] - Description shown at the top of the panel.
+		 * @param {object}  options - Object containing one property: params.
-		 * @param {number=100}     [options.priority] - The sort priority for the panel.
+		 * @param {string}  options.title - Title shown when panel is collapsed and expanded.
-		 * @param {string}         [options.templateId] - Template selector for container.
+		 * @param {string}  [options.description] - Description shown at the top of the panel.
-		 * @param {string=default} [options.type] - The type of the panel. See wp.customize.panelConstructor.
+		 * @param {number}  [options.priority=100] - The sort priority for the panel.
-		 * @param {string=}        [options.content] - The markup to be used for the panel container. If empty, a JS template is used.
+		 * @param {string}  [options.templateId] - Template selector for container.
-		 * @param {boolean=true}   [options.active] - Whether the panel is active or not.
+		 * @param {string}  [options.type=default] - The type of the panel. See wp.customize.panelConstructor.
-		 * @param {object}         [options.params] - Deprecated wrapper for the above properties.
+		 * @param {string}  [options.content] - The markup to be used for the panel container. If empty, a JS template is used.
+		 * @param {boolean} [options.active=true] - Whether the panel is active or not.
+		 * @param {object}  [options.params] - Deprecated wrapper for the above properties.
 		 */
 		initialize: function ( id, options ) {
 			var container = this;
 			container.id = id;
 		/**
 		 * Get the element that will contain the notifications.
 		 *
 		 * @since 4.9.0
 		 * @returns {jQuery} Notification container element.
-		 * @this {wp.customize.Control}
 		 */
 		getNotificationsContainerElement: function() {
 			var container = this;
 			return container.contentContainer.find( '.customize-control-notifications-container:first' );
 		},
 					container.scrollTop( previousScrollTop );
 				}
 			} );
 		},
-		/**
+		/*
-		 * Bring the container into view and then expand this and bring it into view
+		 * is documented using @borrows in the constructor.
-		 * @param {Object} [params]
 		 */
 		focus: focus,
 		/**
 		 * Return the container html, generated from its JS template, if it exists.
 				'class': 'customize-pane-child ' + content.attr( 'class' ) + ' ' + container.attr( 'class' )
 			} );
 		}
 	});
-	/**
+	api.Section = Container.extend(/** @lends wp.customize.Section.prototype */{
-	 * @since 4.1.0
-	 *
-	 * @class
-	 * @augments wp.customize.Class
-	 */
-	api.Section = Container.extend({
 		containerType: 'section',
 		containerParent: '#customize-theme-controls',
 		containerPaneParent: '.customize-pane-parent',
 		defaults: {
 			title: '',
 			panel: null,
 			customizeAction: ''
 		},
 		/**
+		 * @constructs wp.customize.Section
+		 * @augments   wp.customize~Container
+		 *
 		 * @since 4.1.0
 		 *
-		 * @param {string}         id - The ID for the section.
+		 * @param {string}  id - The ID for the section.
-		 * @param {object}         options - Options.
+		 * @param {object}  options - Options.
-		 * @param {string}         options.title - Title shown when section is collapsed and expanded.
+		 * @param {string}  options.title - Title shown when section is collapsed and expanded.
-		 * @param {string=}        [options.description] - Description shown at the top of the section.
+		 * @param {string}  [options.description] - Description shown at the top of the section.
-		 * @param {number=100}     [options.priority] - The sort priority for the section.
+		 * @param {number}  [options.priority=100] - The sort priority for the section.
-		 * @param {string=default} [options.type] - The type of the section. See wp.customize.sectionConstructor.
+		 * @param {string}  [options.type=default] - The type of the section. See wp.customize.sectionConstructor.
-		 * @param {string=}        [options.content] - The markup to be used for the section container. If empty, a JS template is used.
+		 * @param {string}  [options.content] - The markup to be used for the section container. If empty, a JS template is used.
-		 * @param {boolean=true}   [options.active] - Whether the section is active or not.
+		 * @param {boolean} [options.active=true] - Whether the section is active or not.
-		 * @param {string}         options.panel - The ID for the panel this section is associated with.
+		 * @param {string}  options.panel - The ID for the panel this section is associated with.
-		 * @param {string=}        [options.customizeAction] - Additional context information shown before the section title when expanded.
+		 * @param {string}  [options.customizeAction] - Additional context information shown before the section title when expanded.
-		 * @param {object}         [options.params] - Deprecated wrapper for the above properties.
+		 * @param {object}  [options.params] - Deprecated wrapper for the above properties.
 		 */
 		initialize: function ( id, options ) {
 			var section = this, params;
 			params = options.params || options;
 				}
 			}
 		}
 	});
-	/**
+	api.ThemesSection = api.Section.extend(/** @lends wp.customize.ThemesSection.prototype */{
-	 * wp.customize.ThemesSection
-	 *
-	 * Custom section for themes that loads themes by category, and also
-	 * handles the theme-details view rendering and navigation.
-	 *
-	 * @constructor
-	 * @augments wp.customize.Section
-	 * @augments wp.customize.Container
-	 */
-	api.ThemesSection = api.Section.extend({
 		currentTheme: '',
 		overlay: '',
 		template: '',
 		screenshotQueue: null,
 		$window: null,
 		filtersHeight: 0,
 		headerContainer: null,
 		updateCountDebounced: null,
 		/**
-		 * Initialize.
+		 * wp.customize.ThemesSection
+		 *
+		 * Custom section for themes that loads themes by category, and also
+		 * handles the theme-details view rendering and navigation.
+		 *
+		 * @constructs wp.customize.ThemesSection
+		 * @augments   wp.customize.Section
 		 *
 		 * @since 4.9.0
 		 *
 		 * @param {string} id - ID.
 		 * @param {object} options - Options.
 				}
 			});
 		}
 	});
-	/**
+	api.OuterSection = api.Section.extend(/** @lends wp.customize.OuterSection.prototype */{
-	 * Class wp.customize.OuterSection.
-	 *
+		/**
-	 * Creates section outside of the sidebar, there is no ui to trigger collapse/expand so
+		 * Class wp.customize.OuterSection.
-	 * it would require custom handling.
+		 *
-	 *
+		 * Creates section outside of the sidebar, there is no ui to trigger collapse/expand so
-	 * @since 4.9
+		 * it would require custom handling.
-	 *
+		 *
-	 * @constructor
+		 * @constructs wp.customize.OuterSection
-	 * @augments wp.customize.Section
+		 * @augments   wp.customize.Section
-	 * @augments wp.customize.Container
-	 */
-	api.OuterSection = api.Section.extend({
-		/**
-		 * Initialize.
 		 *
 		 * @since 4.9.0
 		 *
 		 * @returns {void}
 		 */
 				}
 			}
 		}
 	});
-	/**
+	api.Panel = Container.extend(/** @lends wp.customize.Panel.prototype */{
-	 * @since 4.1.0
-	 *
-	 * @class
-	 * @augments wp.customize.Class
-	 */
-	api.Panel = Container.extend({
 		containerType: 'panel',
 		/**
+		 * @constructs wp.customize.Panel
+		 * @augments   wp.customize~Container
+		 *
 		 * @since 4.1.0
 		 *
-		 * @param {string}         id - The ID for the panel.
+		 * @param {string}  id - The ID for the panel.
-		 * @param {object}         options - Object containing one property: params.
+		 * @param {object}  options - Object containing one property: params.
-		 * @param {string}         options.title - Title shown when panel is collapsed and expanded.
+		 * @param {string}  options.title - Title shown when panel is collapsed and expanded.
-		 * @param {string=}        [options.description] - Description shown at the top of the panel.
+		 * @param {string}  [options.description] - Description shown at the top of the panel.
-		 * @param {number=100}     [options.priority] - The sort priority for the panel.
+		 * @param {number}  [options.priority=100] - The sort priority for the panel.
-		 * @param {string=default} [options.type] - The type of the panel. See wp.customize.panelConstructor.
+		 * @param {string}  [options.type=default] - The type of the panel. See wp.customize.panelConstructor.
-		 * @param {string=}        [options.content] - The markup to be used for the panel container. If empty, a JS template is used.
+		 * @param {string}  [options.content] - The markup to be used for the panel container. If empty, a JS template is used.
-		 * @param {boolean=true}   [options.active] - Whether the panel is active or not.
+		 * @param {boolean} [options.active=true] - Whether the panel is active or not.
-		 * @param {object}         [options.params] - Deprecated wrapper for the above properties.
+		 * @param {object}  [options.params] - Deprecated wrapper for the above properties.
 		 */
 		initialize: function ( id, options ) {
 			var panel = this, params;
 			params = options.params || options;
 				) ) );
 			}
 		}
 	});
-	/**
+	api.ThemesPanel = api.Panel.extend(/** @lends wp.customize.ThemsPanel.prototype */{
-	 * Class wp.customize.ThemesPanel.
-	 *
+		/**
-	 * Custom section for themes that displays without the customize preview.
+		 *  Class wp.customize.ThemesPanel.
-	 *
+		 *
-	 * @constructor
+		 * Custom section for themes that displays without the customize preview.
-	 * @augments wp.customize.Panel
+		 *
-	 * @augments wp.customize.Container
+		 * @constructs wp.customize.ThemesPanel
-	 */
+		 * @augments   wp.customize.Panel
-	api.ThemesPanel = api.Panel.extend({
-		/**
-		 * Initialize.
 		 *
 		 * @since 4.9.0
 		 *
 		 * @param {string} id - The ID for the panel.
 		 * @param {object} options - Options.
 			section.closeDetails();
 			section.focus();
 		}
 	});
-	/**
+	api.Control = api.Class.extend(/** @lends wp.customize.Control.prototype */{
-	 * A Customizer Control.
-	 *
-	 * A control provides a UI element that allows a user to modify a Customizer Setting.
-	 *
-	 * @see PHP class WP_Customize_Control.
-	 *
-	 * @class
-	 * @augments wp.customize.Class
-	 */
-	api.Control = api.Class.extend({
 		defaultActiveArguments: { duration: 'fast', completeCallback: $.noop },
 		/**
 		 * Default params.
 		 *
 			active: true,
 			priority: 10
 		},
 		/**
-		 * Initialize.
+		 * A Customizer Control.
+		 *
+		 * A control provides a UI element that allows a user to modify a Customizer Setting.
+		 *
+		 * @see PHP class WP_Customize_Control.
+		 *
+		 * @constructs wp.customize.Control
+		 * @augments   wp.customize.Class
+		 *
+		 * @borrows wp.customize~focus as this#focus
+		 * @borrows wp.customize~Container#activate as this#activate
+		 * @borrows wp.customize~Container#deactivate as this#deactivate
+		 * @borrows wp.customize~Container#_toggleActive as this#_toggleActive
 		 *
 		 * @param {string} id                       - Unique identifier for the control instance.
 		 * @param {object} options                  - Options hash for the control instance.
 		 * @param {object} options.type             - Type of control (e.g. text, radio, dropdown-pages, etc.)
 		 * @param {string} [options.content]        - The HTML content for the control or at least its container. This should normally be left blank and instead supplying a templateId.
 		 * Injects the notification container for existing controls that lack the necessary container,
 		 * including special handling for nav menu items and widgets.
 		 *
 		 * @since 4.6.0
 		 * @returns {jQuery} Setting validation message element.
-		 * @this {wp.customize.Control}
 		 */
 		getNotificationsContainerElement: function() {
 			var control = this, controlTitle, notificationsContainer;
 			notificationsContainer = control.container.find( '.customize-control-notifications-container:first' );
 		 */
 		expand: function ( params ) {
 			api.section( this.section() ).expand( params );
 		},
-		/**
+		/*
-		 * Bring the containing section and panel into view and then
+		 * Documented using @borrows in the constructor.
-		 * this control into view, focusing on the first input.
 		 */
 		focus: focus,
 		/**
 		 * Update UI in response to a change in the control's active state.
 		 */
 		toggle: function ( active ) {
 			return this.onChangeActive( active, this.defaultActiveArguments );
 		},
-		/**
+		/*
-		 * Shorthand way to enable the active state.
+		 * Documented using @borrows in the constructor
-		 *
-		 * @since 4.1.0
-		 *
-		 * @param {Object} [params]
-		 * @returns {Boolean} false if already active
 		 */
 		activate: Container.prototype.activate,
-		/**
+		/*
-		 * Shorthand way to disable the active state.
+		 * Documented using @borrows in the constructor
-		 *
-		 * @since 4.1.0
-		 *
-		 * @param {Object} [params]
-		 * @returns {Boolean} false if already inactive
 		 */
 		deactivate: Container.prototype.deactivate,
-		/**
+		/*
-		 * Re-use _toggleActive from Container class.
+		 * Documented using @borrows in the constructor
-		 *
-		 * @access private
 		 */
 		_toggleActive: Container.prototype._toggleActive,
 		// @todo This function appears to be dead code and can be removed.
 		dropdownInit: function() {
 	});
 	/**
 	 * A colorpicker control.
 	 *
-	 * @class
+	 * @class    wp.customize.ColorControl
 	 * @augments wp.customize.Control
-	 * @augments wp.customize.Class
 	 */
-	api.ColorControl = api.Control.extend({
+	api.ColorControl = api.Control.extend(/** @lends wp.customize.ColorControl.prototype */{
 		ready: function() {
 			var control = this,
 				isHueSlider = this.params.mode === 'hue',
 				updating = false,
 				picker;
 	});
 	/**
 	 * A control that implements the media modal.
 	 *
-	 * @class
+	 * @class    wp.customize.MediaControl
 	 * @augments wp.customize.Control
-	 * @augments wp.customize.Class
 	 */
-	api.MediaControl = api.Control.extend({
+	api.MediaControl = api.Control.extend(/** @lends wp.customize.MediaControl.prototype */{
 		/**
 		 * When the control's DOM structure is ready,
 		 * set up internal event bindings.
 		 */
 	});
 	/**
 	 * An upload control, which utilizes the media modal.
 	 *
-	 * @class
+	 * @class    wp.customize.UploadControl
 	 * @augments wp.customize.MediaControl
-	 * @augments wp.customize.Control
-	 * @augments wp.customize.Class
 	 */
-	api.UploadControl = api.MediaControl.extend({
+	api.UploadControl = api.MediaControl.extend(/** @lends wp.customize.UploadControl.prototype */{
 		/**
 		 * Callback handler for when an attachment is selected in the media modal.
 		 * Gets the selected image information, and sets it within the control.
 		 */
 	 * A control for uploading images.
 	 *
 	 * This control no longer needs to do anything more
 	 * than what the upload control does in JS.
 	 *
-	 * @class
+	 * @class    wp.customize.ImageControl
 	 * @augments wp.customize.UploadControl
-	 * @augments wp.customize.MediaControl
-	 * @augments wp.customize.Control
-	 * @augments wp.customize.Class
 	 */
-	api.ImageControl = api.UploadControl.extend({
+	api.ImageControl = api.UploadControl.extend(/** @lends wp.customize.ImageControl.prototype */{
 		// @deprecated
 		thumbnailSrc: function() {}
 	});
 	/**
 	 * A control for uploading background images.
 	 *
-	 * @class
+	 * @class    wp.customize.BackgroundControl
 	 * @augments wp.customize.UploadControl
-	 * @augments wp.customize.MediaControl
-	 * @augments wp.customize.Control
-	 * @augments wp.customize.Class
 	 */
-	api.BackgroundControl = api.UploadControl.extend({
+	api.BackgroundControl = api.UploadControl.extend(/** @lends wp.customize.BackgroundControl.prototype */{
 		/**
 		 * When the control's DOM structure is ready,
 		 * set up internal event bindings.
 		 */
 	/**
 	 * A control for positioning a background image.
 	 *
 	 * @since 4.7.0
 	 *
-	 * @class
+	 * @class    wp.customize.BackgroundPositionControl
 	 * @augments wp.customize.Control
-	 * @augments wp.customize.Class
 	 */
-	api.BackgroundPositionControl = api.Control.extend( {
+	api.BackgroundPositionControl = api.Control.extend(/** @lends wp.customize.BackgroundPositionControl.prototype */{
 		/**
 		 * Set up control UI once embedded in DOM and settings are created.
 		 *
 		 * @since 4.7.0
 	} );
 	/**
 	 * A control for selecting and cropping an image.
 	 *
-	 * @class
+	 * @class    wp.customize.CroppedImageControl
 	 * @augments wp.customize.MediaControl
-	 * @augments wp.customize.Control
-	 * @augments wp.customize.Class
 	 */
-	api.CroppedImageControl = api.MediaControl.extend({
+	api.CroppedImageControl = api.MediaControl.extend(/** @lends wp.customize.CroppedImageControl.prototype */{
 		/**
 		 * Open the media modal to the library state.
 		 */
 		openFrame: function( event ) {
 	});
 	/**
 	 * A control for selecting and cropping Site Icons.
 	 *
-	 * @class
+	 * @class    wp.customize.SiteIconControl
 	 * @augments wp.customize.CroppedImageControl
-	 * @augments wp.customize.MediaControl
-	 * @augments wp.customize.Control
-	 * @augments wp.customize.Class
 	 */
-	api.SiteIconControl = api.CroppedImageControl.extend({
+	api.SiteIconControl = api.CroppedImageControl.extend(/** @lends wp.customize.SiteIconControl.prototype */{
 		/**
 		 * Create a media modal select frame, and store it so the instance can be reused when needed.
 		 */
 		initFrame: function() {
 			$( 'link[rel="icon"][sizes="32x32"]' ).attr( 'href', '/favicon.ico' ); // Set to default.
 		}
 	});
 	/**
-	 * @class
+	 * @class    wp.customize.HeaderControl
 	 * @augments wp.customize.Control
-	 * @augments wp.customize.Class
 	 */
-	api.HeaderControl = api.Control.extend({
+	api.HeaderControl = api.Control.extend(/** @lends wp.customize.HeaderControl.prototype */{
 		ready: function() {
 			this.btnRemove = $('#customize-control-header_image .actions .remove');
 			this.btnNew    = $('#customize-control-header_image .actions .new');
 			_.bindAll(this, 'openMedia', 'removeImage');
 	});
 	/**
 	 * wp.customize.ThemeControl
 	 *
-	 * @constructor
+	 * @class    wp.customize.ThemeControl
 	 * @augments wp.customize.Control
-	 * @augments wp.customize.Class
 	 */
-	api.ThemeControl = api.Control.extend({
+	api.ThemeControl = api.Control.extend(/** @lends wp.customize.ThemeControl.prototype */{
 		touchDrag: false,
 		screenshotRendered: false,
 		/**
 	/**
 	 * Class wp.customize.CodeEditorControl
 	 *
 	 * @since 4.9.0
 	 *
-	 * @constructor
+	 * @class    wp.customize.CodeEditorControl
 	 * @augments wp.customize.Control
-	 * @augments wp.customize.Class
 	 */
-	api.CodeEditorControl = api.Control.extend({
+	api.CodeEditorControl = api.Control.extend(/** @lends wp.customize.CodeEditorControl.prototype */{
 		/**
 		 * Initialize.
 		 *
 		 * @since 4.9.0
 	/**
 	 * Class wp.customize.DateTimeControl.
 	 *
 	 * @since 4.9.0
-	 * @constructor
+	 * @class    wp.customize.DateTimeControl
 	 * @augments wp.customize.Control
-	 * @augments wp.customize.Class
 	 */
-	api.DateTimeControl = api.Control.extend({
+	api.DateTimeControl = api.Control.extend(/** @lends wp.customize.DateTimeControl.prototype */{
 		/**
 		 * Initialize behaviors.
 		 *
 		 * @since 4.9.0
 	/**
 	 * Class PreviewLinkControl.
 	 *
 	 * @since 4.9.0
-	 * @constructor
+	 * @class    wp.customize.PreviewLinkControl
 	 * @augments wp.customize.Control
-	 * @augments wp.customize.Class
 	 */
-	api.PreviewLinkControl = api.Control.extend({
+	api.PreviewLinkControl = api.Control.extend(/** @lends wp.customize.PreviewLinkControl.prototype */{
 		defaults: _.extend( {}, api.Control.prototype.defaults, {
 			templateId: 'customize-preview-link-control'
 		} ),
 				control.notifications.remove( notificationCode );
 			}
 		}
 	});
-	// Change objects contained within the main customize object to Settings.
+	/**
+	 * Change objects contained within the main customize object to Settings.
+	 *
+	 * @alias wp.customize.defaultConstructor
+	 */
 	api.defaultConstructor = api.Setting;
 	/**
 	 * Callback for resolved controls.
 	 *
-	 * @callback deferredControlsCallback
+	 * @callback wp.customize.deferredControlsCallback
-	 * @param {wp.customize.Control[]} Resolved controls.
+	 * @param {wp.customize.Control[]} controls Resolved controls.
 	 */
 	/**
 	 * Collection of all registered controls.
+	 *
+	 * @alias wp.customize.control
 	 *
 	 * @since 3.4.0
 	 *
 	 * @type {Function}
 	 * @param {...string} ids - One or more ids for controls to obtain.
 	api.control = new api.Values({ defaultConstructor: api.Control });
 	/**
 	 * Callback for resolved sections.
 	 *
-	 * @callback deferredSectionsCallback
+	 * @callback wp.customize.deferredSectionsCallback
-	 * @param {wp.customize.Section[]} Resolved sections.
+	 * @param {wp.customize.Section[]} sections Resolved sections.
 	 */
 	/**
 	 * Collection of all registered sections.
+	 *
+	 * @alias wp.customize.section
 	 *
 	 * @since 3.4.0
 	 *
 	 * @type {Function}
 	 * @param {...string} ids - One or more ids for sections to obtain.
 	api.section = new api.Values({ defaultConstructor: api.Section });
 	/**
 	 * Callback for resolved panels.
 	 *
-	 * @callback deferredPanelsCallback
+	 * @callback wp.customize.deferredPanelsCallback
-	 * @param {wp.customize.Panel[]} Resolved panels.
+	 * @param {wp.customize.Panel[]} panels Resolved panels.
 	 */
 	/**
 	 * Collection of all registered panels.
+	 *
+	 * @alias wp.customize.panel
 	 *
 	 * @since 4.0.0
 	 *
 	 * @type {Function}
 	 * @param {...string} ids - One or more ids for panels to obtain.
 	api.panel = new api.Values({ defaultConstructor: api.Panel });
 	/**
 	 * Callback for resolved notifications.
 	 *
-	 * @callback deferredNotificationsCallback
+	 * @callback wp.customize.deferredNotificationsCallback
-	 * @param {wp.customize.Notification[]} Resolved notifications.
+	 * @param {wp.customize.Notification[]} notifications Resolved notifications.
 	 */
 	/**
 	 * Collection of all global notifications.
+	 *
+	 * @alias wp.customize.notifications
 	 *
 	 * @since 4.9.0
 	 *
 	 * @type {Function}
 	 * @param {...string} codes - One or more codes for notifications to obtain.
 	 *
 	 * @see {@link wp.customize.control} for further examples of how to interact with {@link wp.customize.Values} instances.
 	 */
 	api.notifications = new api.Notifications();
-	/**
+	api.PreviewFrame = api.Messenger.extend(/** @lends wp.customize.PreviewFrame.prototype */{
-	 * 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
-	 * @mixes wp.customize.Events
-	 */
-	api.PreviewFrame = api.Messenger.extend({
 		sensitivity: null, // Will get set to api.settings.timeouts.previewFrameSensitivity.
 		/**
-		 * Initialize the PreviewFrame.
+		 * An object that fetches a preview in the background of the document, which
+		 * allows for seamless replacement of an existing preview.
+		 *
+		 * @constructs wp.customize.PreviewFrame
+		 * @augments   wp.customize.Messenger
 		 *
 		 * @param {object} params.container
 		 * @param {object} params.previewUrl
 		 * @param {object} params.query
 		 * @param {object} options
 			previewFrame.iframe = $( '<iframe />', {
 				title: api.l10n.previewIframeTitle,
 				name: 'customize-' + previewFrame.channel()
 			} );
 			previewFrame.iframe.attr( 'onmousewheel', '' ); // Workaround for Safari bug. See WP Trac #38149.
+			previewFrame.iframe.attr( 'sandbox', 'allow-forms allow-modals allow-orientation-lock allow-pointer-lock allow-popups allow-popups-to-escape-sandbox allow-presentation allow-same-origin allow-scripts' );
 			if ( ! hasPendingChangesetUpdate ) {
 				previewFrame.iframe.attr( 'src', urlParser.href );
 			} else {
 				previewFrame.iframe.attr( 'data-src', urlParser.href ); // For debugging purposes.
 	}());
 	/**
 	 * Set the document title of the customizer.
 	 *
+	 * @alias wp.customize.setDocumentTitle
+	 *
 	 * @since 4.1.0
 	 *
 	 * @param {string} documentTitle
 	 */
 	api.setDocumentTitle = function ( documentTitle ) {
 		title = tmpl.replace( '%s', documentTitle );
 		document.title = title;
 		api.trigger( 'title', title );
 	};
-	/**
+	api.Previewer = api.Messenger.extend(/** @lends wp.customize.Previewer.prototype */{
-	 * @class
-	 * @augments wp.customize.Messenger
-	 * @augments wp.customize.Class
-	 * @mixes wp.customize.Events
-	 */
-	api.Previewer = api.Messenger.extend({
 		refreshBuffer: null, // Will get set to api.settings.timeouts.windowRefresh.
 		/**
+		 * @constructs wp.customize.Previewer
+		 * @augments   wp.customize.Messenger
+		 *
 		 * @param {array}  params.allowedUrls
 		 * @param {string} params.container   A selector or jQuery element for the preview
 		 *                                    frame to be placed.
 		 * @param {string} params.form
 		 * @param {string} params.previewUrl  The URL to preview.
 	/**
 	 * Handle setting_validities in an error response for the customize-save request.
 	 *
 	 * Add notifications to the settings and focus on the first control that has an invalid setting.
 	 *
+	 * @alias wp.customize._handleSettingValidities
+	 *
 	 * @since 4.6.0
 	 * @private
 	 *
 	 * @param {object}  args
 	 * @param {object}  args.settingValidities
 	};
 	/**
 	 * Find all controls associated with the given settings.
 	 *
+	 * @alias wp.customize.findControlsForSettings
+	 *
 	 * @since 4.6.0
 	 * @param {string[]} settingIds Setting IDs.
 	 * @returns {object<string, wp.customize.Control>} Mapping setting ids to arrays of controls.
 	 */
 	api.findControlsForSettings = function findControlsForSettings( settingIds ) {
 		return controls;
 	};
 	/**
 	 * Sort panels, sections, controls by priorities. Hide empty sections and panels.
+	 *
+	 * @alias wp.customize.reflowPaneContents
 	 *
 	 * @since 4.1.0
 	 */
 	api.reflowPaneContents = _.bind( function () {
 				section.toggleClass( 'open' );
 				$( this ).attr( 'aria-expanded', true );
 			}
 		});
-		// Initialize Previewer
+		/**
+		 * Initialize Previewer
+		 *
+		 * @alias wp.customize.previewer
+		 */
 		api.previewer = new api.Previewer({
 			container:   '#customize-preview',
 			form:        '#customize-controls',
 			previewUrl:  api.settings.url.preview,
 			allowedUrls: api.settings.url.allowed
-		}, {
+		},/** @lends wp.customize.previewer */{
 			nonce: api.settings.nonce,
 			/**
 			 * Build the query to send along with the Preview request.
 		 *
 		 * @since 4.9.0
 		 */
 		( function checkAndDisplayLockNotice() {
-			/**
+			var LockedNotification = api.OverlayNotification.extend(/** @lends wp.customize~LockedNotification.prototype */{
-			 * A notification that is displayed in a full-screen overlay with information about the locked changeset.
-			 *
-			 * @since 4.9.0
-			 * @class
-			 * @augments wp.customize.Notification
-			 * @augments wp.customize.OverlayNotification
-			 */
-			var LockedNotification = api.OverlayNotification.extend({
 				/**
 				 * Template ID.
 				 *
 				 * @type {string}
 				 * @type {object}
 				 */
 				lockUser: null,
 				/**
-				 * Initialize.
+				 * A notification that is displayed in a full-screen overlay with information about the locked changeset.
+				 *
+				 * @constructs wp.customize~LockedNotification
+				 * @augments   wp.customize.OverlayNotification
 				 *
 				 * @since 4.9.0
 				 *
 				 * @param {string} [code] - Code.
 				 * @param {object} [params] - Params.

enmi-conf.org