Improve the inline documentation for image_edit_apply_changes().

Including:
* Add a correct type (array) for the `$changes` parameter
* Add the `@since` version
* Add proper descriptions for both parameters and the return value.

Props tillkruess for the initial patch.
See #30508.

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


git-svn-id: http://core.svn.wordpress.org/trunk@30634 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Drew Jaynes
2014-11-30 09:59:22 +00:00
parent 5977a7e355
commit e4425165ff
2 changed files with 6 additions and 4 deletions
+5 -3
View File
@@ -403,9 +403,11 @@ function _crop_image_resource($img, $x, $y, $w, $h) {
/**
* Performs group of changes on Editor specified.
*
* @param WP_Image_Editor $image
* @param type $changes
* @return WP_Image_Editor
* @since 2.9.0
*
* @param WP_Image_Editor $image {@see WP_Image_Editor} instance.
* @param array $changes Array of change operations.
* @return WP_Image_Editor {@see WP_Image_Editor} instance with changes applied.
*/
function image_edit_apply_changes( $image, $changes ) {
if ( is_resource( $image ) )