Changeset 47122 for trunk/src/wp-includes/class-wp-image-editor-imagick.php

Timestamp:

01/29/2020 12:43:23 AM (7 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-includes/class-wp-image-editor-imagick.php (modified) (8 diffs)

trunk/src/wp-includes/class-wp-image-editor-imagick.php

@@ -24 +24 @@
         public function __destruct() {
                 if ( $this->image instanceof Imagick ) {
-                        // we don't need the original in memory anymore
+                        // We don't need the original in memory anymore.
                         $this->image->clear();
                         $this->image->destroy();
@@ -155 +155 @@
                         }
 
-                        // Select the first frame to handle animated images properly
+                        // Select the first frame to handle animated images properly.
                         if ( is_callable( array( $this->image, 'setIteratorIndex' ) ) ) {
                                 $this->image->setIteratorIndex( 0 );
@@ -264 +264 @@
                 }
 
-                // Execute the resize
+                // Execute the resize.
                 $thumb_result = $this->thumbnail_image( $dst_w, $dst_h );
                 if ( is_wp_error( $thumb_result ) ) {
@@ -531 +531 @@
 
                         if ( $dst_w || $dst_h ) {
-                                // If destination width/height isn't specified, use same as
-                                // width/height from source.
+                                // If destination width/height isn't specified,
+                                // use same as width/height from source.
                                 if ( ! $dst_w ) {
                                         $dst_w = $src_w;
@@ -676 +676 @@
 
                 try {
-                        // Store initial Format
+                        // Store initial format.
                         $orig_format = $this->image->getImageFormat();
 
@@ -682 +682 @@
                         $this->make_image( $filename, array( $image, 'writeImage' ), array( $filename ) );
 
-                        // Reset original Format
+                        // Reset original format.
                         $this->image->setImageFormat( $orig_format );
                 } catch ( Exception $e ) {
@@ -688 +688 @@
                 }
 
-                // Set correct file permissions
+                // Set correct file permissions.
                 $stat  = stat( dirname( $filename ) );
-                $perms = $stat['mode'] & 0000666; //same permissions as parent folder, strip off the executable bits
+                $perms = $stat['mode'] & 0000666; // Same permissions as parent folder, strip off the executable bits.
                 chmod( $filename, $perms );
 
@@ -715 +715 @@
 
                 try {
-                        // Temporarily change format for stream
+                        // Temporarily change format for stream.
                         $this->image->setImageFormat( strtoupper( $extension ) );
 
-                        // Output stream of image content
+                        // Output stream of image content.
                         header( "Content-Type: $mime_type" );
                         print $this->image->getImageBlob();
 
-                        // Reset Image to original Format
+                        // Reset image to original format.
                         $this->image->setImageFormat( $this->get_extension( $this->mime_type ) );
                 } catch ( Exception $e ) {