From d87ccc1655a9c7bb60119aa39bfe30ef9dbfb399 Mon Sep 17 00:00:00 2001
From: Peter Wilson <peterwilsoncc@git.wordpress.org>
Date: Thu, 15 Jun 2017 13:23:22 +0000
Subject: [PATCH] Docs: Add `wp-admin/js/custom-background.js` documentation.

Props jipmoors.
Fixes #41067.


git-svn-id: https://develop.svn.wordpress.org/trunk@40914 602fd350-edb4-49c9-b593-d223f7449a82
---
 src/wp-admin/js/custom-background.js | 64 ++++++++++++++++++++++++++--
 1 file changed, 61 insertions(+), 3 deletions(-)

diff --git a/src/wp-admin/js/custom-background.js b/src/wp-admin/js/custom-background.js
index c3f4e294f1..9e96015e75 100644
--- a/src/wp-admin/js/custom-background.js
+++ b/src/wp-admin/js/custom-background.js
@@ -1,9 +1,24 @@
 /* global ajaxurl */
+
+/**
+ * @summary Registers all events for customizing the background.
+ *
+ * @since 3.0.0
+ *
+ * @requires jQuery
+ */
 (function($) {
 	$(document).ready(function() {
 		var frame,
 			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 ) {
 				bgImage.css('background-color', ui.color.toString());
@@ -13,22 +28,57 @@
 			}
 		});
 
+		/**
+		 * @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);
 
@@ -54,13 +104,21 @@
 				button: {
 					// 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.
 				var attachment = frame.state().get('selection').first();