From a26f7f7d2800633f50626bd0a4627cc9fe5fd110 Mon Sep 17 00:00:00 2001
From: Scott Taylor <wonderboymusic@git.wordpress.org>
Date: Sat, 20 Aug 2016 22:58:34 +0000
Subject: [PATCH] Media: Add some docs to `media-gallery.js` RIP.

Props jipmoors.
Fixes #37717.


git-svn-id: https://develop.svn.wordpress.org/trunk@38293 602fd350-edb4-49c9-b593-d223f7449a82
---
 src/wp-admin/js/media-gallery.js | 19 ++++++++++++++++---
 1 file changed, 16 insertions(+), 3 deletions(-)

diff --git a/src/wp-admin/js/media-gallery.js b/src/wp-admin/js/media-gallery.js
index 52da393dcc..a71d8fe17f 100644
--- a/src/wp-admin/js/media-gallery.js
+++ b/src/wp-admin/js/media-gallery.js
@@ -1,20 +1,33 @@
 /* global ajaxurl */
-jQuery(function($){
-	$( 'body' ).bind( 'click.wp-gallery', function(e){
+
+/**
+ * This file is used on media-upload.php which has been replaced by media-new.php and upload.php
+ * Deprecated since 3.5.0
+ */
+jQuery(function($) {
+	/**
+	 * Adds a click event handler to the element with a 'wp-gallery' class.
+	 */
+	$( 'body' ).bind( 'click.wp-gallery', function(e) {
 		var target = $( e.target ), id, img_size;
 
 		if ( target.hasClass( 'wp-set-header' ) ) {
+			// Opens the image to preview it full size.
 			( window.dialogArguments || opener || parent || top ).location.href = target.data( 'location' );
 			e.preventDefault();
 		} else if ( target.hasClass( 'wp-set-background' ) ) {
+			// Sets the image as background of the theme.
 			id = target.data( 'attachment-id' );
 			img_size = $( 'input[name="attachments[' + id + '][image-size]"]:checked').val();
 
+			/**
+			 * This AJAX action has been deprecated since 3.5.0, see custom-background.php
+			 */
 			jQuery.post(ajaxurl, {
 				action: 'set-background-image',
 				attachment_id: id,
 				size: img_size
-			}, function(){
+			}, function() {
 				var win = window.dialogArguments || opener || parent || top;
 				win.tb_remove();
 				win.location.reload();