Changeset 47122 for trunk/tests/phpunit/tests/image/editor.php

Timestamp:

01/29/2020 12:43:23 AM (5 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/tests/phpunit/tests/image/editor.php (modified) (8 diffs)

trunk/tests/phpunit/tests/image/editor.php

@@ -70 +70 @@
     public function test_set_quality() {
 
-        // Get an editor
+        // Get an editor.
         $editor = wp_get_image_editor( DIR_TESTDATA . '/images/canola.jpg' );
         $editor->set_mime_type( 'image/jpeg' ); // Ensure mime-specific filters act properly.
 
-        // Check default value
+        // Check default value.
         $this->assertEquals( 82, $editor->get_quality() );
 
@@ -86 +86 @@
         $this->assertEquals( 82, $editor->get_quality() );
 
-        // Ensure set_quality() works and overrides the filters
+        // Ensure set_quality() works and overrides the filters.
         $this->assertTrue( $editor->set_quality( 75 ) );
         $this->assertEquals( 75, $editor->get_quality() );
 
-        // Get a new editor to clear default quality state
+        // Get a new editor to clear default quality state.
         unset( $editor );
         $editor = wp_get_image_editor( DIR_TESTDATA . '/images/canola.jpg' );
@@ -98 +98 @@
         $this->assertEquals( 95, $editor->get_quality() );
 
-        // Get a new editor to clear jpeg_quality state
+        // Get a new editor to clear jpeg_quality state.
         remove_filter( 'jpeg_quality', $func_95_percent );
         unset( $editor );
@@ -106 +106 @@
         $this->assertEquals( 100, $editor->get_quality() );
 
-        // Clean up
+        // Clean up.
         remove_filter( 'wp_editor_set_quality', $func_100_percent );
     }
@@ -117 +117 @@
     public function test_generate_filename() {
 
-        // Get an editor
+        // Get an editor.
         $editor = wp_get_image_editor( DIR_TESTDATA . '/images/canola.jpg' );
 
@@ -130 +130 @@
         );
 
-        // Test with no parameters
+        // Test with no parameters.
         $this->assertEquals( 'canola-100x50.jpg', wp_basename( $editor->generate_filename() ) );
 
-        // Test with a suffix only
+        // Test with a suffix only.
         $this->assertEquals( 'canola-new.jpg', wp_basename( $editor->generate_filename( 'new' ) ) );
 
-        // Test with a destination dir only
+        // Test with a destination dir only.
         $this->assertEquals( trailingslashit( realpath( get_temp_dir() ) ), trailingslashit( realpath( dirname( $editor->generate_filename( null, get_temp_dir() ) ) ) ) );
 
-        // Test with a suffix only
+        // Test with a suffix only.
         $this->assertEquals( 'canola-100x50.png', wp_basename( $editor->generate_filename( null, null, 'png' ) ) );
 
@@ -155 +155 @@
         $editor = wp_get_image_editor( DIR_TESTDATA . '/images/canola.jpg' );
 
-        // Size should be false by default
+        // Size should be false by default.
         $this->assertNull( $editor->get_size() );
 
-        // Set a size
+        // Set a size.
         $size     = array(
             'height' => 50,
@@ -178 +178 @@
         $editor = wp_get_image_editor( DIR_TESTDATA . '/images/canola.jpg' );
 
-        // Size should be false by default
+        // Size should be false by default.
         $this->assertFalse( $editor->get_suffix() );
 
-        // Set a size
+        // Set a size.
         $size     = array(
             'height' => 50,