Changeset 40914

Timestamp:

06/15/2017 01:23:22 PM (8 years ago)

Author:

peterwilsoncc

Message:

Docs: Add wp-admin/js/custom-background.js documentation.

Props jipmoors.
Fixes #41067.

File:

• trunk/src/wp-admin/js/custom-background.js (modified) (4 diffs)

trunk/src/wp-admin/js/custom-background.js

@@ -1 +1 @@
 /* global ajaxurl */
+
+/**
+ * @summary Registers all events for customizing the background.
+ *
+ * @since 3.0.0
+ *
+ * @requires jQuery
+ */
 (function($) {
     $(document).ready(function() {
@@ -5 +13 @@
             bgImage = $( '#custom-background-image' );
 
+        /**
+         * @summary Instantiates the WordPress color picker and binds the change and clear events.
+         *
+         * @since 3.5.0
+         *
+         * @returns {void}
+         */
         $('#background-color').wpColorPicker({
             change: function( event, ui ) {
@@ -14 +29 @@
         });
 
+        /**
+         * @summary Alters the background size CSS property whenever the background size input has changed.
+         *
+         * @since 4.7.0
+         *
+         * @returns {void}
+         */
         $( 'select[name="background-size"]' ).change( function() {
             bgImage.css( 'background-size', $( this ).val() );
         });
 
+        /**
+         * @summary Alters the background position CSS property whenever the background position input has changed.
+         *
+         * @since 4.7.0
+         *
+         * @returns {void}
+         */
         $( 'input[name="background-position"]' ).change( function() {
             bgImage.css( 'background-position', $( this ).val() );
         });
 
+        /**
+         * @summary Alters the background repeat CSS property whenever the background repeat input has changed.
+         *
+         * @since 3.0.0
+         *
+         * @returns {void}
+         */
         $( 'input[name="background-repeat"]' ).change( function() {
             bgImage.css( 'background-repeat', $( this ).is( ':checked' ) ? 'repeat' : 'no-repeat' );
         });
 
+        /**
+         * @summary Alters the background attachment CSS property whenever the background attachment input has changed.
+         *
+         * @since 4.7.0
+         *
+         * @returns {void}
+         */
         $( 'input[name="background-attachment"]' ).change( function() {
             bgImage.css( 'background-attachment', $( this ).is( ':checked' ) ? 'scroll' : 'fixed' );
         });
 
+        /**
+         * @summary Binds the event for opening the WP Media dialog.
+         *
+         * @since 3.5.0
+         *
+         * @returns {void}
+         */
         $('#choose-from-library-link').click( function( event ) {
             var $el = $(this);
@@ -55 +105 @@
                     // Set the text of the button.
                     text: $el.data('update'),
-                    // Tell the button not to close the modal, since we're
-                    // going to refresh the page when the image is selected.
+                    /*
+                     * Tell the button not to close the modal, since we're
+                     * going to refresh the page when the image is selected.
+                     */
                     close: false
                 }
             });
 
-            // When an image is selected, run a callback.
+            /**
+             * @summary When an image is selected, run a callback.
+             *
+             * @since 3.5.0
+             *
+             * @returns {void}
+             */
             frame.on( 'select', function() {
                 // Grab the selected attachment.