WordPress 3.9

[autoinstalls/wordpress.git] / wp-includes / class-wp-image-editor.php

diff --git a/wp-includes/class-wp-image-editor.php b/wp-includes/class-wp-image-editor.php
index 7f6488f91f530e32ddff312e3f9b191ea809c327..5affba48c7f78ae677d7ce4af9cdc5480b7f0ee9 100644 (file)
--- a/wp-includes/class-wp-image-editor.php
+++ b/wp-includes/class-wp-image-editor.php
@@ -82,13 +82,17 @@ abstract class WP_Image_Editor {
        /**
         * Resizes current image.
         *
+        * At minimum, either a height or width must be provided.
+        * If one of the two is set to null, the resize will
+        * maintain aspect ratio according to the provided dimension.
+        *
         * @since 3.5.0
         * @access public
         * @abstract
         *
-        * @param int $max_w
-        * @param int $max_h
-        * @param boolean $crop
+        * @param  int|null $max_w Image width.
+        * @param  int|null $max_h Image height.
+        * @param  boolean  $crop
         * @return boolean|WP_Error
         */
        abstract public function resize( $max_w, $max_h, $crop = false );