From a679368d8baa83c1bb6361b62607a9441b0c11d0 Mon Sep 17 00:00:00 2001 From: Scott Taylor Date: Sat, 22 Aug 2015 17:23:37 +0000 Subject: [PATCH] Add some JS Docs for Customizer. Props ericlewis. See #33503. git-svn-id: https://develop.svn.wordpress.org/trunk@33709 602fd350-edb4-49c9-b593-d223f7449a82 --- src/wp-includes/js/customize-loader.js | 4 ++++ src/wp-includes/js/customize-preview.js | 6 ++++-- 2 files changed, 8 insertions(+), 2 deletions(-) diff --git a/src/wp-includes/js/customize-loader.js b/src/wp-includes/js/customize-loader.js index ce69a359c6..5bc34c4367 100644 --- a/src/wp-includes/js/customize-loader.js +++ b/src/wp-includes/js/customize-loader.js @@ -1,4 +1,8 @@ /* global _wpCustomizeLoaderSettings, confirm */ +/* + * Expose a public API that allows the customizer to be + * loaded on any page. + */ window.wp = window.wp || {}; (function( exports, $ ){ diff --git a/src/wp-includes/js/customize-preview.js b/src/wp-includes/js/customize-preview.js index e58c8d6d44..7cea7d3738 100644 --- a/src/wp-includes/js/customize-preview.js +++ b/src/wp-includes/js/customize-preview.js @@ -1,3 +1,6 @@ +/* + * Script run inside a Customizer preview frame. + */ (function( exports, $ ){ var api = wp.customize, debounce; @@ -30,8 +33,7 @@ */ api.Preview = api.Messenger.extend({ /** - * Requires params: - * - url - the URL of preview frame + * @param {string} url The URL of preview frame */ initialize: function( params, options ) { var self = this;