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

Timestamp:

07/09/2023 09:23:34 PM (3 years ago)

Author:

audrasjb

Message:

Docs: Replace multiple single line comments with multi-line comments.

This changeset updates various comments as per WordPress PHP Inline Documentation Standards.
See ​https://developer.wordpress.org/coding-standards/inline-documentation-standards/php/#5-inline-comments.

Follow-up to [56174], [56175], [56176], [56177].

Props costdev, audrasjb.
See #58459.

File:

• trunk/src/wp-includes/class-wp-image-editor-imagick.php (modified) (4 diffs)

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

@@ -103 +103 @@
                 }
 
-                // setIteratorIndex is optional unless mime is an animated format.
-                // Here, we just say no if you are missing it and aren't loading a jpeg.
+                /*
+                 * setIteratorIndex is optional unless mime is an animated format.
+                 * Here, we just say no if you are missing it and aren't loading a jpeg.
+                 */
                 if ( ! method_exists( 'Imagick', 'setIteratorIndex' ) && 'image/jpeg' !== $mime_type ) {
                                 return false;
@@ -603 +605 @@
 
                         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;
@@ -958 +962 @@
         protected function pdf_setup() {
                 try {
-                        // By default, PDFs are rendered in a very low resolution.
-                        // We want the thumbnail to be readable, so increase the rendering DPI.
+                        /*
+                         * By default, PDFs are rendered in a very low resolution.
+                         * We want the thumbnail to be readable, so increase the rendering DPI.
+                         */
                         $this->image->setResolution( 128, 128 );
 
@@ -987 +993 @@
 
                 try {
-                        // When generating thumbnails from cropped PDF pages, Imagemagick uses the uncropped
-                        // area (resulting in unnecessary whitespace) unless the following option is set.
+                        /*
+                         * When generating thumbnails from cropped PDF pages, Imagemagick uses the uncropped
+                         * area (resulting in unnecessary whitespace) unless the following option is set.
+                         */
                         $this->image->setOption( 'pdf:use-cropbox', true );
 
-                        // Reading image after Imagick instantiation because `setResolution`
-                        // only applies correctly before the image is read.
+                        /*
+                         * Reading image after Imagick instantiation because `setResolution`
+                         * only applies correctly before the image is read.
+                         */
                         $this->image->readImage( $filename );
                 } catch ( Exception $e ) {