From b3bc78df8f11a07557f63969e962f3033660406b Mon Sep 17 00:00:00 2001
From: Drew Jaynes <info@drewapicture.com>
Date: Wed, 4 Dec 2013 23:32:11 +0000
Subject: [PATCH] Hook docs fixes following [26645].

See #25721.

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


git-svn-id: http://core.svn.wordpress.org/trunk@26538 1a063a9b-81f0-0310-95a4-ce76da25c4cd
---
 wp-admin/includes/image-edit.php         |  1 +
 wp-includes/class-wp-image-editor-gd.php |  3 ++-
 wp-includes/class-wp-image-editor.php    | 21 ++++++++++++---------
 3 files changed, 15 insertions(+), 10 deletions(-)

diff --git a/wp-admin/includes/image-edit.php b/wp-admin/includes/image-edit.php
index 40cea96eb0..f25546e5e7 100644
--- a/wp-admin/includes/image-edit.php
+++ b/wp-admin/includes/image-edit.php
@@ -259,6 +259,7 @@ function wp_save_image_file( $filename, $image, $mime_type, $post_id ) {
 
 		switch ( $mime_type ) {
 			case 'image/jpeg':
+				/** This filter is documented in wp-includes/class-wp-image-editor.php */
 				return imagejpeg( $image, $filename, apply_filters( 'jpeg_quality', 90, 'edit_image' ) );
 			case 'image/png':
 				return imagepng( $image, $filename );
diff --git a/wp-includes/class-wp-image-editor-gd.php b/wp-includes/class-wp-image-editor-gd.php
index 3735cd8076..b91d6133e9 100644
--- a/wp-includes/class-wp-image-editor-gd.php
+++ b/wp-includes/class-wp-image-editor-gd.php
@@ -91,7 +91,8 @@ class WP_Image_Editor_GD extends WP_Image_Editor {
 		 *
 		 * @since 3.5.0
 		 *
-		 * @param int Maximum memory limit to allocate (default is WP_MAX_MEMORY_LIMIT)
+		 * @param string $limit Maximum memory limit to allocate for images. Default value
+		 *                      of WP_MAX_MEMORY_LIMIT is '256M'.
 		 */
 		// Set artificially high because GD uses uncompressed images in memory
 		@ini_set( 'memory_limit', apply_filters( 'image_memory_limit', WP_MAX_MEMORY_LIMIT ) );
diff --git a/wp-includes/class-wp-image-editor.php b/wp-includes/class-wp-image-editor.php
index 3570ca96fa..908a11340d 100644
--- a/wp-includes/class-wp-image-editor.php
+++ b/wp-includes/class-wp-image-editor.php
@@ -213,7 +213,7 @@ abstract class WP_Image_Editor {
 		}
 
 		/**
-		 * Filter the default quality setting.
+		 * Filter the default image compression quality setting.
 		 *
 		 * @since 3.5.0
 		 *
@@ -221,15 +221,18 @@ abstract class WP_Image_Editor {
 		 */
 		$quality = apply_filters( 'wp_editor_set_quality', $quality, $this->mime_type );
 
-		/**
-		 * Filter the JPEG quality for backwards compatibilty.
-		 *
-		 * @since 2.5.0
-		 *
-		 * @param int $quality Quality level between 0 (low) and 100 (high) of the JPEG.
-		 * @param string The context of the filter.
-		 */
 		if ( 'image/jpeg' == $this->mime_type ) {
+			/**
+			 * Filter the JPEG compression quality for backward-compatibility.
+			 *
+			 * The filter is evaluated under two contexts: 'image_resize', and 'edit_image',
+			 * (when a JPEG image is saved to file).
+			 *
+			 * @since 2.5.0
+			 *
+			 * @param int    $quality Quality level between 0 (low) and 100 (high) of the JPEG.
+			 * @param string $context Context of the filter.
+			 */
 			$quality = apply_filters( 'jpeg_quality', $quality, 'image_resize' );
 
 			// Allow 0, but squash to 1 due to identical images in GD, and for backwards compatibility.