Changeset 30644

Timestamp:

11/30/2014 09:58:54 AM (11 years ago)

Author:

DrewAPicture

Message:

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.

File:

• trunk/src/wp-admin/includes/image-edit.php (modified) (1 diff)

trunk/src/wp-admin/includes/image-edit.php

@@ -404 +404 @@
  * 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 ) {