Merge pull request #436 from WordPress/fix/phpcs

felixarntz · web-flow · commit ab08abd37778 · 2022-07-27T16:09:51.000+02:00
PHPCS: Use a period at the end
diff --git a/admin/load.php b/admin/load.php
@@ -385,7 +385,7 @@ function perflab_admin_pointer( $hook_suffix ) {
 add_action( 'admin_enqueue_scripts', 'perflab_admin_pointer' );
 
 /**
- * Renders the Admin Pointer
+ * Renders the Admin Pointer.
  *
  * Handles the rendering of the admin pointer.
  *
diff --git a/modules/images/dominant-color/class-dominant-color-image-editor-gd.php b/modules/images/dominant-color/class-dominant-color-image-editor-gd.php
@@ -11,7 +11,7 @@
 
 /**
  * WordPress Image Editor Class for Image Manipulation through GD
- * with dominant color detection
+ * with dominant color detection.
  *
  * @since 1.2.0
  *
diff --git a/modules/images/dominant-color/class-dominant-color-image-editor-imagick.php b/modules/images/dominant-color/class-dominant-color-image-editor-imagick.php
@@ -11,7 +11,7 @@
 
 /**
  * WordPress Image Editor Class for Image Manipulation through Imagick
- * with dominant color detection
+ * with dominant color detection.
  *
  * @since 1.2.0
  *
diff --git a/modules/images/dominant-color/load.php b/modules/images/dominant-color/load.php
@@ -34,7 +34,7 @@ function dominant_color_metadata( $metadata, $attachment_id ) {
 add_filter( 'wp_generate_attachment_metadata', 'dominant_color_metadata', 10, 2 );
 
 /**
- * Filter various image attributes to add the dominant color to the image
+ * Filters various image attributes to add the dominant color to the image.
  *
  * @since 1.2.0
  *
@@ -145,9 +145,9 @@ function dominant_color_img_tag_add_dominant_color( $filtered_image, $context, $
 	 *
 	 * @since 1.2.0
 	 *
-	 * @param string $content the content to filter.
-	 * @param string $context the context of the content.
-	 * @return string content
+	 * @param string $content The content to filter.
+	 * @param string $context The context of the content.
+	 * @return string The updated $content.
 	 */
 	function dominant_color_filter_content_tags( $content, $context = null ) {
 		if ( null === $context ) {
diff --git a/modules/images/webp-uploads/helper.php b/modules/images/webp-uploads/helper.php
@@ -64,7 +64,7 @@ function webp_uploads_get_upload_image_mime_transforms() {
  * @param string      $mime                  The target mime in which the image should be created.
  * @param string|null $destination_file_name The path where the file would be stored, including the extension. If null, `generate_filename` is used to create the destination file name.
  *
- * @return array|WP_Error An array with the file and filesize if the image was created correctly otherwise a WP_Error
+ * @return array|WP_Error An array with the file and filesize if the image was created correctly, otherwise a WP_Error.
  */
 function webp_uploads_generate_additional_image_source( $attachment_id, $image_size, array $size_data, $mime, $destination_file_name = null ) {
 	/**
@@ -80,7 +80,7 @@ function webp_uploads_generate_additional_image_source( $attachment_id, $image_s
 	 * @param string              $image_size    The size name that would be used to create this image, out of the registered subsizes.
 	 * @param array               $size_data     An array with the dimensions of the image: height, width and crop {'height'=>int, 'width'=>int, 'crop'}.
 	 * @param string              $mime          The target mime in which the image should be created.
-	 * @return array|null|WP_Error An array with the file and filesize if the image was created correctly otherwise a WP_Error
+	 * @return array|null|WP_Error array|null|WP_Error An array with the file and filesize if the image was created correctly, otherwise a WP_Error.
 	 */
 	$image = apply_filters( 'webp_uploads_pre_generate_additional_image_source', null, $attachment_id, $image_size, $size_data, $mime );
 	if ( is_wp_error( $image ) ) {
diff --git a/modules/images/webp-uploads/load.php b/modules/images/webp-uploads/load.php
@@ -497,7 +497,7 @@ function webp_uploads_update_image_references( $content ) {
  * for the specified image sizes, the *.webp references are stored inside of each size.
  *
  * @since 1.0.0
- * @since 1.3.0 Remove `webp_uploads_prefer_smaller_image_file` filter
+ * @since 1.3.0 Remove `webp_uploads_prefer_smaller_image_file` filter.
  *
  * @param string $original_image An <img> tag where the urls would be updated.
  * @param string $context        The context where this is function is being used.

Original file line number	Diff line number	Diff line change
`@@ -385,7 +385,7 @@ function perflab_admin_pointer( $hook_suffix ) {`
`385`	`385`	`add_action( 'admin_enqueue_scripts', 'perflab_admin_pointer' );`
`386`	`386`
`387`	`387`	`/**`
`388`		`- * Renders the Admin Pointer`
	`388`	`+ * Renders the Admin Pointer.`
`389`	`389`	`*`
`390`	`390`	`* Handles the rendering of the admin pointer.`
`391`	`391`	`*`
Original file line number	Diff line number	Diff line change
`@@ -11,7 +11,7 @@`
`11`	`11`
`12`	`12`	`/**`
`13`	`13`	`* WordPress Image Editor Class for Image Manipulation through GD`
`14`		`- * with dominant color detection`
	`14`	`+ * with dominant color detection.`
`15`	`15`	`*`
`16`	`16`	`* @since 1.2.0`
`17`	`17`	`*`
Original file line number	Diff line number	Diff line change
`@@ -34,7 +34,7 @@ function dominant_color_metadata( $metadata, $attachment_id ) {`
`34`	`34`	`add_filter( 'wp_generate_attachment_metadata', 'dominant_color_metadata', 10, 2 );`
`35`	`35`
`36`	`36`	`/**`
`37`		`- * Filter various image attributes to add the dominant color to the image`
	`37`	`+ * Filters various image attributes to add the dominant color to the image.`
`38`	`38`	`*`
`39`	`39`	`* @since 1.2.0`
`40`	`40`	`*`
`@@ -145,9 +145,9 @@ function dominant_color_img_tag_add_dominant_color( $filtered_image, $context, $`
`145`	`145`	`*`
`146`	`146`	`* @since 1.2.0`
`147`	`147`	`*`
`148`		`- * @param string $content the content to filter.`
`149`		`- * @param string $context the context of the content.`
`150`		`- * @return string content`
	`148`	`+ * @param string $content The content to filter.`
	`149`	`+ * @param string $context The context of the content.`
	`150`	`+ * @return string The updated $content.`
`151`	`151`	`*/`
`152`	`152`	`function dominant_color_filter_content_tags( $content, $context = null ) {`
`153`	`153`	`if ( null === $context ) {`
Original file line number	Diff line number	Diff line change
`@@ -497,7 +497,7 @@ function webp_uploads_update_image_references( $content ) {`
`497`	`497`	`* for the specified image sizes, the *.webp references are stored inside of each size.`
`498`	`498`	`*`
`499`	`499`	`* @since 1.0.0`
`500`		- * @since 1.3.0 Remove `webp_uploads_prefer_smaller_image_file` filter
	`500`	+ * @since 1.3.0 Remove `webp_uploads_prefer_smaller_image_file` filter.
`501`	`501`	`*`
`502`	`502`	`* @param string $original_image An <img> tag where the urls would be updated.`
`503`	`503`	`* @param string $context The context where this is function is being used.`