wp/wp-includes/js/customize-selective-refresh.js
changeset 16 a86126ab1dd4
parent 9 177826044cd9
child 21 48c4eec2b7e6
--- a/wp/wp-includes/js/customize-selective-refresh.js	Tue Oct 22 16:11:46 2019 +0200
+++ b/wp/wp-includes/js/customize-selective-refresh.js	Tue Dec 15 13:49:49 2020 +0100
@@ -59,14 +59,14 @@
 		 *
 		 * @since 4.5.0
 		 *
-		 * @param {string} id                      - Unique identifier for the partial instance.
-		 * @param {object} options                 - Options hash for the partial instance.
-		 * @param {string} options.type            - Type of partial (e.g. nav_menu, widget, etc)
-		 * @param {string} options.selector        - jQuery selector to find the container element in the page.
-		 * @param {array}  options.settings        - The IDs for the settings the partial relates to.
-		 * @param {string} options.primarySetting  - The ID for the primary setting the partial renders.
-		 * @param {bool}   options.fallbackRefresh - Whether to refresh the entire preview in case of a partial refresh failure.
-		 * @param {object} [options.params]        - Deprecated wrapper for the above properties.
+		 * @param {string}  id                      - Unique identifier for the partial instance.
+		 * @param {Object}  options                 - Options hash for the partial instance.
+		 * @param {string}  options.type            - Type of partial (e.g. nav_menu, widget, etc)
+		 * @param {string}  options.selector        - jQuery selector to find the container element in the page.
+		 * @param {Array}   options.settings        - The IDs for the settings the partial relates to.
+		 * @param {string}  options.primarySetting  - The ID for the primary setting the partial renders.
+		 * @param {boolean} options.fallbackRefresh - Whether to refresh the entire preview in case of a partial refresh failure.
+		 * @param {Object}  [options.params]        - Deprecated wrapper for the above properties.
 		 */
 		initialize: function( id, options ) {
 			var partial = this;
@@ -120,7 +120,7 @@
 		 * @access public
 		 *
 		 * @param {Placement} placement The placement container element.
-		 * @returns {void}
+		 * @return {void}
 		 */
 		createEditShortcutForPlacement: function( placement ) {
 			var partial = this, $shortcut, $placementContainer, illegalAncestorSelector, illegalContainerSelector;
@@ -150,7 +150,7 @@
 		 *
 		 * @param {Placement} placement The placement for the partial.
 		 * @param {jQuery} $editShortcut The shortcut element as a jQuery object.
-		 * @returns {void}
+		 * @return {void}
 		 */
 		addEditShortcutToPlacement: function( placement, $editShortcut ) {
 			var $placementContainer = $( placement.container );
@@ -285,7 +285,7 @@
 		 *
 		 * @since 4.5.0
 		 *
-		 * @return {String[]}
+		 * @return {string[]}
 		 */
 		settings: function() {
 			var partial = this;
@@ -406,9 +406,9 @@
 		 *
 		 * @param {Placement}             placement
 		 * @param {Element|jQuery}        [placement.container]  - This param will be empty if there was no element matching the selector.
-		 * @param {string|object|boolean} placement.addedContent - Rendered HTML content, a data object for JS templates to render, or false if no render.
-		 * @param {object}                [placement.context]    - Optional context information about the container.
-		 * @returns {boolean} Whether the rendering was successful and the fallback was not invoked.
+		 * @param {string|Object|boolean} placement.addedContent - Rendered HTML content, a data object for JS templates to render, or false if no render.
+		 * @param {Object}                [placement.context]    - Optional context information about the container.
+		 * @return {boolean} Whether the rendering was successful and the fallback was not invoked.
 		 */
 		renderContent: function( placement ) {
 			var partial = this, content, newContainerElement;
@@ -442,7 +442,7 @@
 
 				if ( partial.params.containerInclusive ) {
 
-					// Note that content may be an empty string, and in this case jQuery will just remove the oldContainer
+					// Note that content may be an empty string, and in this case jQuery will just remove the oldContainer.
 					newContainerElement = $( content );
 
 					// Merge the new context on top of the old context.
@@ -602,12 +602,12 @@
 		 *
 		 * @since 4.5.0
 		 *
-		 * @param {object}                   args
+		 * @param {Object}                   args
 		 * @param {Partial}                  args.partial
 		 * @param {jQuery|Element}           [args.container]
 		 * @param {Node}                     [args.startNode]
 		 * @param {Node}                     [args.endNode]
-		 * @param {object}                   [args.context]
+		 * @param {Object}                   [args.context]
 		 * @param {string}                   [args.addedContent]
 		 * @param {jQuery|DocumentFragment}  [args.removedNodes]
 		 */
@@ -645,7 +645,7 @@
 	 * @since 4.5.0
 	 * @see wp.customize.previewer.query()
 	 *
-	 * @return {object}
+	 * @return {Object}
 	 */
 	self.getCustomizeQuery = function() {
 		var dirtyCustomized = {};