enmi-conf.org: comparison wp/wp-includes/js/customize-preview-widgets.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-includes/js/customize-preview-widgets.js

changeset 16	a86126ab1dd4
parent 9	177826044cd9

equal deleted inserted replaced

-:3d4e9c994f10
+:a86126ab1dd4
 * @param {jQuery} $   The jQuery object.
 * @param {Object} _   The utilities library.
 * @param {Object} wp  Current WordPress environment instance.
 * @param {Object} api Information from the API.
 *
-* @returns {Object} Widget-related variables.
+* @return {Object} Widget-related variables.
 */
 wp.customize.widgetsPreview = wp.customize.WidgetCustomizerPreview = (function( $, _, wp, api ) {
 	var self;
 	 *
 	 * @since 4.5.0
 	 *
 	 * @memberOf wp.customize.widgetsPreview
 	 *
-	 * @returns {void}
+	 * @return {void}
 	 */
 	self.init = function() {
 		var self = this;
 		self.preview = api.preview;
 		/**
 		 * Refreshes the widget partial.
 		 *
 		 * @since 4.5.0
 		 *
-		 * @returns {Promise|void} Either a promise postponing the refresh, or void.
+		 * @return {Promise|void} Either a promise postponing the refresh, or void.
 		 */
 		refresh: function() {
 			var partial = this, refreshDeferred;
 			if ( ! self.selectiveRefreshableWidgets[ partial.widgetIdParts.idBase ] ) {
 				refreshDeferred = $.Deferred();
 		 *
 		 * @inheritDoc
 		 * @param {wp.customize.selectiveRefresh.Placement} placement The placement
 		 *                                                            function.
 		 *
-		 * @returns {void}
+		 * @return {void}
 		 */
 		renderContent: function( placement ) {
 			var partial = this;
 			if ( api.selectiveRefresh.Partial.prototype.renderContent.call( partial, placement ) ) {
 				api.preview.send( 'widget-updated', partial.widgetId );
 		/**
 		 * Sets up the partial.
 		 *
 		 * @since 4.5.0
 		 *
-		 * @returns {void}
+		 * @return {void}
 		 */
 		ready: function() {
 			var sidebarPartial = this;
 			// Watch for changes to the sidebar_widgets setting.
 		 *
 		 * Note that TreeWalker is not implemented in IE8.
 		 *
 		 * @since 4.5.0
 		 *
-		 * @returns {Array.<{before: Comment, after: Comment, instanceNumber: number}>}
+		 * @return {Array.<{before: Comment, after: Comment, instanceNumber: number}>}
-		 *          An array with an object for each sidebar instance, containing the
+		 *         An array with an object for each sidebar instance, containing the
-		 *          node before and after the sidebar instance and its instance number.
+		 *         node before and after the sidebar instance and its instance number.
 		 */
 		findDynamicSidebarBoundaryNodes: function() {
 			var partial = this, regExp, boundaryNodes = {}, recursiveCommentTraversal;
 			regExp = /^(dynamic_sidebar_before|dynamic_sidebar_after):(.+):(\d+)$/;
 			recursiveCommentTraversal = function( childNodes ) {
 		/**
 		 * Gets the placements for this partial.
 		 *
 		 * @since 4.5.0
 		 *
-		 * @returns {Array} An array containing placement objects for each of the
+		 * @return {Array} An array containing placement objects for each of the
-		 *                  dynamic sidebar boundary nodes.
+		 *                 dynamic sidebar boundary nodes.
 		 */
 		placements: function() {
 			var partial = this;
 			return _.map( partial.findDynamicSidebarBoundaryNodes(), function( boundaryNodes ) {
 				return new api.selectiveRefresh.Placement( {
 		 *
 		 * @since 4.5.0
 		 *
 		 * @throws {Error} If there's no settingId.
 		 * @throws {Error} If the setting doesn't exist in the API.
-		 * @throws {Error} If the API doesn't pass an array of widget ids.
+		 * @throws {Error} If the API doesn't pass an array of widget IDs.
 		 *
-		 * @returns {Array} A shallow copy of the array containing widget IDs.
+		 * @return {Array} A shallow copy of the array containing widget IDs.
 		 */
 		getWidgetIds: function() {
 			var sidebarPartial = this, settingId, widgetIds;
 			settingId = sidebarPartial.settings()[0];
 			if ( ! settingId ) {
 		 * Reflows widgets in the sidebar, ensuring they have the proper position in the
 		 * DOM.
 		 *
 		 * @since 4.5.0
 		 *
-		 * @returns {Array.<wp.customize.selectiveRefresh.Placement>} List of placements
+		 * @return {Array.<wp.customize.selectiveRefresh.Placement>} List of placements
-		 *                                                            that were reflowed.
+		 *                                                           that were reflowed.
 		 */
 		reflowWidgets: function() {
 			var sidebarPartial = this, sidebarPlacements, widgetIds, widgetPartials, sortedSidebarContainers = [];
 			widgetIds = sidebarPartial.getWidgetIds();
 			sidebarPlacements = sidebarPartial.placements();
 		 *
 		 * @since 4.5.0
 		 *
 		 * @param {string} widgetId The widget ID.
 		 *
-		 * @returns {wp.customize.selectiveRefresh.Partial} The widget instance partial.
+		 * @return {wp.customize.selectiveRefresh.Partial} The widget instance partial.
 		 */
 		ensureWidgetPlacementContainers: function( widgetId ) {
 			var sidebarPartial = this, widgetPartial, wasInserted = false, partialId = 'widget[' + widgetId + ']';
 			widgetPartial = api.selectiveRefresh.partial( partialId );
 			if ( ! widgetPartial ) {
 		 * @since 4.5.0
 		 *
 		 * @param {Array} newWidgetIds New widget IDs.
 		 * @param {Array} oldWidgetIds Old widget IDs.
 		 *
-		 * @returns {void}
+		 * @return {void}
 		 */
 		handleSettingChange: function( newWidgetIds, oldWidgetIds ) {
 			var sidebarPartial = this, needsRefresh, widgetsRemoved, widgetsAdded, addedWidgetPartials = [];
 			needsRefresh = (
 		 * Note that the meat is handled in handleSettingChange because it has the
 		 * context of which widgets were removed.
 		 *
 		 * @since 4.5.0
 		 *
-		 * @returns {Promise} A promise postponing the refresh.
+		 * @return {Promise} A promise postponing the refresh.
 		 */
 		refresh: function() {
 			var partial = this, deferred = $.Deferred();
 			deferred.fail( function() {
 	/**
 	 * Adds partials for the registered widget areas (sidebars).
 	 *
 	 * @since 4.5.0
 	 *
-	 * @returns {void}
+	 * @return {void}
 	 */
 	self.addPartials = function() {
 		_.each( self.registeredSidebars, function( registeredSidebar ) {
 			var partial, partialId = 'sidebar[' + registeredSidebar.id + ']';
 			partial = api.selectiveRefresh.partial( partialId );
 	 *
 	 * @memberOf wp.customize.widgetsPreview
 	 *
 	 * @since 3.9.0
 	 *
-	 * @returns {void}
+	 * @return {void}
 	 */
 	self.buildWidgetSelectors = function() {
 		var self = this;
 		$.each( self.registeredSidebars, function( i, sidebar ) {
 	 * Highlights the widget on widget updates or widget control mouse overs.
 	 *
 	 * @memberOf wp.customize.widgetsPreview
 	 *
 	 * @since 3.9.0
-	 * @param  {string} widgetId ID of the widget.
+	 * @param {string} widgetId ID of the widget.
 	 *
-	 * @returns {void}
+	 * @return {void}
 	 */
 	self.highlightWidget = function( widgetId ) {
 		var $body = $( document.body ),
 			$widget = $( '#' + widgetId );
 	 *
 	 * @memberOf wp.customize.widgetsPreview
 	 *
 	 * @since 3.9.0
 	 *
-	 * @returns {void}
+	 * @return {void}
 	 */
 	self.highlightControls = function() {
 		var self = this,
 			selector = this.widgetSelectors.join( ',' );
 		// Highlights widget when entering the widget editor.
 		$( document ).on( 'mouseenter', selector, function() {
 			self.preview.send( 'highlight-widget-control', $( this ).prop( 'id' ) );
 		});
-		// Open expand the widget control when shift+clicking the widget element
+		// Open expand the widget control when shift+clicking the widget element.
 		$( document ).on( 'click', selector, function( e ) {
 			if ( ! e.shiftKey ) {
 				return;
 			}
 			e.preventDefault();
 	 *
 	 * @since 4.5.0
 	 *
 	 * @param {string} widgetId The widget ID.
 	 *
-	 * @returns {{idBase: string, number: number|null}} An object containing the
+	 * @return {{idBase: string, number: number|null}} An object containing the idBase
-	 *          idBase and number of the parsed widget ID.
+	 *                                                 and number of the parsed widget ID.
 	 */
 	self.parseWidgetId = function( widgetId ) {
 		var matches, parsed = {
 			idBase: '',
 			number: null
 	 *
 	 * @since 4.5.0
 	 *
 	 * @param {string} settingId Widget setting ID.
 	 *
-	 * @returns {{idBase: string, number: number|null}|null} Either an object
+	 * @return {{idBase: string, number: number|null}|null} Either an object containing the idBase
-	 *          containing the idBase and number of the parsed widget setting ID, or
+	 *                                                      and number of the parsed widget setting ID,
-	 *          null.
+	 *                                                      or null.
 	 */
 	self.parseWidgetSettingId = function( settingId ) {
 		var matches, parsed = {
 			idBase: '',
 			number: null
 	 *
 	 * @since 4.5.0
 	 *
 	 * @param {string} widgetId The widget ID.
 	 *
-	 * @returns {string} The setting ID.
+	 * @return {string} The setting ID.
 	 */
 	self.getWidgetSettingId = function( widgetId ) {
 		var parsed = this.parseWidgetId( widgetId ), settingId;
 		settingId = 'widget_' + parsed.idBase;

enmi-conf.org