Customize: Clean up docs and code style for customize changes in 4.7.

* Adds missing `resolve`/`fail` for promise returned by `loadThemePreview`.
* Adds missing jsdoc blocks and tags.
* Adds missing phpdoc and makes corrections.

See #37770.
Fixes #38908.

Built from https://develop.svn.wordpress.org/trunk@39345


git-svn-id: http://core.svn.wordpress.org/trunk@39285 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Weston Ruter
2016-11-23 06:05:32 +00:00
parent e20ded7e75
commit 6b5d960453
11 changed files with 125 additions and 34 deletions

View File

@@ -104,6 +104,7 @@ wp.customize.selectiveRefresh = ( function( $, api ) {
* Create and show the edit shortcut for a given partial placement container.
*
* @since 4.7.0
* @access public
*
* @param {Placement} placement The placement container element.
* @returns {void}
@@ -132,6 +133,7 @@ wp.customize.selectiveRefresh = ( function( $, api ) {
* Add an edit shortcut to the placement container.
*
* @since 4.7.0
* @access public
*
* @param {Placement} placement The placement for the partial.
* @param {jQuery} $editShortcut The shortcut element as a jQuery object.
@@ -149,6 +151,7 @@ wp.customize.selectiveRefresh = ( function( $, api ) {
* Return the unique class name for the edit shortcut button for this partial.
*
* @since 4.7.0
* @access public
*
* @return {string} Partial ID converted into a class name for use in shortcut.
*/
@@ -162,6 +165,7 @@ wp.customize.selectiveRefresh = ( function( $, api ) {
* Return the appropriate translated string for the edit shortcut button.
*
* @since 4.7.0
* @access public
*
* @return {string} Tooltip for edit shortcut.
*/
@@ -187,6 +191,7 @@ wp.customize.selectiveRefresh = ( function( $, api ) {
* Will use `params.type` if set, but otherwise will try to infer type from settingId.
*
* @since 4.7.0
* @access public
*
* @return {string} Type of partial derived from type param or the related setting ID.
*/
@@ -209,6 +214,7 @@ wp.customize.selectiveRefresh = ( function( $, api ) {
* Create an edit shortcut button for this partial.
*
* @since 4.7.0
* @access public
*
* @return {jQuery} The edit shortcut button element.
*/