Changeset 18827 for trunk/wp-includes/media.php

Timestamp:

09/29/2011 10:57:43 PM (13 years ago)

Author:

ryan

Message:

phpdoc typo and readability fixes. Props SergeyBiryukov. fixes #18560

File:

• trunk/wp-includes/media.php (modified) (10 diffs)

trunk/wp-includes/media.php

@@ -18 +18 @@
  * not set.
  *
- * Finally, there is a filter named, 'editor_max_image_size' that will be called
+ * Finally, there is a filter named 'editor_max_image_size', that will be called
  * on the calculated array for width and height, respectively. The second
  * parameter will be the value that was in the $size parameter. The returned
@@ -178 +178 @@
 /**
  * Registers a new image size
+ *
+ * @since 2.9.0
  */
 function add_image_size( $name, $width = 0, $height = 0, $crop = false ) {
@@ -186 +188 @@
 /**
  * Registers an image size for the post thumbnail
+ *
+ * @since 2.9.0
  */
 function set_post_thumbnail_size( $width = 0, $height = 0, $crop = false ) {
@@ -330 +334 @@
  * @param int $dest_h New height.
  * @param bool $crop Optional, default is false. Whether to crop image or resize.
- * @return bool|array False, on failure. Returned array matches parameters for imagecopyresampled() PHP function.
+ * @return bool|array False on failure. Returned array matches parameters for imagecopyresampled() PHP function.
  */
 function image_resize_dimensions($orig_w, $orig_h, $dest_w, $dest_h, $crop = false) {
@@ -399 +403 @@
  * @param int $max_h Maximum height to resize to.
  * @param bool $crop Optional. Whether to crop image or resize.
- * @param string $suffix Optional. File Suffix.
+ * @param string $suffix Optional. File suffix.
  * @param string $dest_path Optional. New image file path.
  * @param int $jpeg_quality Optional, default is 90. Image quality percentage.
@@ -670 +674 @@
 
 /**
- * Adds a 'wp-post-image' class to post thumbnail thumbnails
+ * Adds a 'wp-post-image' class to post thumbnails
  * Uses the begin_fetch_post_thumbnail_html and end_fetch_post_thumbnail_html action hooks to
- * dynamically add/remove itself so as to only filter post thumbnail thumbnails
+ * dynamically add/remove itself so as to only filter post thumbnails
  *
  * @since 2.9.0
@@ -753 +757 @@
  * @since 2.5.0
  *
- * @param array $attr Attributes attributed to the shortcode.
+ * @param array $attr Attributes of the shortcode.
  * @return string HTML content to display gallery.
  */
@@ -907 +911 @@
  * @since 2.5.0
  *
- * @param bool $prev Optional. Default is true to display previous link, true for next.
+ * @param bool $prev Optional. Default is true to display previous link, false for next.
  */
 function adjacent_image_link($prev = true, $size = 'thumbnail', $text = false) {
@@ -1080 +1084 @@
 
     /**
-     * If a post/page was saved, then output Javascript to make
+     * If a post/page was saved, then output JavaScript to make
      * an AJAX request that will call WP_Embed::cache_oembed().
      */
@@ -1374 +1378 @@
  *
  * @param string $url The URL that should be embedded.
- * @param array $args Addtional arguments and parameters.
+ * @param array $args Additional arguments and parameters.
  * @return string The original URL on failure or the embed HTML on success.
  */