Changeset 47122 for trunk/src/wp-admin/includes/image.php

Timestamp:

01/29/2020 12:43:23 AM (6 years ago)

Author:

SergeyBiryukov

Message:

Docs: Improve inline comments per the documentation standards.

Includes minor code layout fixes for better readability.

See #48303.

File:

• trunk/src/wp-admin/includes/image.php (modified) (9 diffs)

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

@@ -273 +273 @@
         $threshold = (int) apply_filters( 'big_image_size_threshold', 2560, $imagesize, $file, $attachment_id );
 
-        // If the original image's dimensions are over the threshold, scale the image
-        // and use it as the "full" size.
+        // If the original image's dimensions are over the threshold,
+        // scale the image and use it as the "full" size.
         if ( $threshold && ( $image_meta['width'] > $threshold || $image_meta['height'] > $threshold ) ) {
             $editor = wp_get_image_editor( $file );
@@ -283 +283 @@
             }
 
-            // Resize the image
+            // Resize the image.
             $resized = $editor->resize( $threshold, $threshold );
             $rotated = null;
@@ -306 +306 @@
                     }
                 } else {
-                    // TODO: log errors.
+                    // TODO: Log errors.
                 }
             } else {
-                // TODO: log errors.
+                // TODO: Log errors.
             }
         } elseif ( ! empty( $exif_meta['orientation'] ) && (int) $exif_meta['orientation'] !== 1 ) {
@@ -336 +336 @@
                     }
                 } else {
-                    // TODO: log errors.
+                    // TODO: Log errors.
                 }
             }
@@ -435 +435 @@
 
         if ( is_wp_error( $rotated ) ) {
-            // TODO: log errors.
+            // TODO: Log errors.
         }
     }
@@ -444 +444 @@
 
             if ( is_wp_error( $new_size_meta ) ) {
-                // TODO: log errors.
+                // TODO: Log errors.
             } else {
                 // Save the size meta value.
@@ -576 +576 @@
             $editor = wp_get_image_editor( $file );
 
-            if ( ! is_wp_error( $editor ) ) { // No support for this type of file
+            if ( ! is_wp_error( $editor ) ) { // No support for this type of file.
                 /*
                  * PDFs may have the same file filename as JPEGs.
@@ -716 +716 @@
             $iptc = @iptcparse( $info['APP13'] );
 
-            // Headline, "A brief synopsis of the caption."
+            // Headline, "A brief synopsis of the caption".
             if ( ! empty( $iptc['2#105'][0] ) ) {
                 $meta['title'] = trim( $iptc['2#105'][0] );
                 /*
                 * Title, "Many use the Title field to store the filename of the image,
-                * though the field may be used in many ways."
+                * though the field may be used in many ways".
                 */
             } elseif ( ! empty( $iptc['2#005'][0] ) ) {
@@ -727 +727 @@
             }
 
-            if ( ! empty( $iptc['2#120'][0] ) ) { // description / legacy caption
+            if ( ! empty( $iptc['2#120'][0] ) ) { // Description / legacy caption.
                 $caption = trim( $iptc['2#120'][0] );