Tests: Merge file-level and class-level DocBlocks in various unit tes…

…t files. Per the [https://developer.wordpress.org/coding-standards/inline-documentation-standards/php/#6-file-headers documentation standards], whenever possible, all WordPress files should contain a header DocBlock, regardless of the file’s contents – this includes files containing classes. However, this recommendation makes less sense for unit test classes if not applied consistently, and the duplicate tags cause some confusion. This commit aims to reduce confusion and avoid repeating information by combining the DocBlocks. Follow-up to [40607], [43183], [43291], [43292], [43499], [43568], [44502], [44535], [44628], [44786], [44824], [44906], [44909], [46175]. Props wojtekn, antonvlasenko, arafatjamil01, hztyfoon, mukesh27, costdev, jamilbd07, robinwpdeveloper, SergeyBiryukov. Fixes #57099. git-svn-id: https://develop.svn.wordpress.org/trunk@55337 602fd350-edb4-49c9-b593-d223f7449a82
WordPress · Feb 14, 2023 · 5f87589 · 5f87589
1 parent ba508bc
commit 5f87589
Show file tree

Hide file tree

Showing 16 changed files with 5 additions and 100 deletions.
diff --git a/tests/phpunit/tests/admin/wpCommunityEvents.php b/tests/phpunit/tests/admin/wpCommunityEvents.php
@@ -5,15 +5,9 @@
  * @package WordPress
  * @subpackage UnitTests
  * @since 4.8.0
- */
-
-/**
- * Class Tests_Admin_wpCommunityEvents.
  *
  * @group admin
  * @group community-events
- *
- * @since 4.8.0
  */
 class Tests_Admin_wpCommunityEvents extends WP_UnitTestCase {
 

diff --git a/tests/phpunit/tests/admin/wpPrivacyRequestsTable.php b/tests/phpunit/tests/admin/wpPrivacyRequestsTable.php
@@ -5,15 +5,9 @@
  * @package WordPress\UnitTests
  *
  * @since 5.1.0
- */
-
-/**
- * Tests_Admin_wpPrivacyRequestsTable class.
  *
  * @group admin
  * @group privacy
- *
- * @since 5.1.0
  */
 class Tests_Admin_wpPrivacyRequestsTable extends WP_UnitTestCase {
 

diff --git a/tests/phpunit/tests/ajax/wpAjaxWpPrivacyErasePersonalData.php b/tests/phpunit/tests/ajax/wpAjaxWpPrivacyErasePersonalData.php
@@ -4,12 +4,6 @@
  *
  * @package WordPress\UnitTests
  * @since 5.2.0
- */
-
-/**
- * Tests_Ajax_PrivacyExportPersonalData class.
- *
- * @since 5.2.0
  *
  * @group ajax
  * @group privacy

diff --git a/tests/phpunit/tests/ajax/wpAjaxWpPrivacyExportPersonalData.php b/tests/phpunit/tests/ajax/wpAjaxWpPrivacyExportPersonalData.php
@@ -4,12 +4,6 @@
  *
  * @package WordPress\UnitTests
  * @since 5.2.0
- */
-
-/**
- * Tests_Ajax_PrivacyExportPersonalData class.
- *
- * @since 5.2.0
  *
  * @group ajax
  * @group privacy

diff --git a/tests/phpunit/tests/comment/isAvatarCommentType.php b/tests/phpunit/tests/comment/isAvatarCommentType.php
@@ -5,15 +5,9 @@
  * @package WordPress\UnitTests
  *
  * @since 5.1.0
- */
-
-/**
- * Tests_Comment_IsAvatarCommentType class.
  *
  * @group comment
  *
- * @since 5.1.0
- *
  * @covers ::is_avatar_comment_type
  */
 class Tests_Comment_IsAvatarCommentType extends WP_UnitTestCase {

diff --git a/tests/phpunit/tests/functions/doEnclose.php b/tests/phpunit/tests/functions/doEnclose.php
@@ -1,16 +1,11 @@
 <?php
+
 /**
  * Test cases for the `do_enclose()` function.
  *
  * @package WordPress\UnitTests
  *
  * @since 5.3.0
- */
-
-/**
- * Tests_Functions_DoEnclose class.
- *
- * @since 5.3.0
  *
  * @group functions.php
  * @group post

diff --git a/tests/phpunit/tests/privacy/wpCreateUserRequest.php b/tests/phpunit/tests/privacy/wpCreateUserRequest.php
@@ -1,19 +1,13 @@
 <?php
 /**
- * Test the `wp_create_user_request()` function.
+ * Test cases for the `wp_create_user_request()` function.
  *
  * @package WordPress
  * @subpackage UnitTests
  * @since 5.2.0
- */
-
-/**
- * Tests_Privacy_wpCreateUserRequest class.
  *
  * @group privacy
  * @covers ::wp_create_user_request
- *
- * @since 5.2.0
  */
 class Tests_Privacy_wpCreateUserRequest extends WP_UnitTestCase {
 	/**

diff --git a/tests/phpunit/tests/privacy/wpPrivacyCompletedRequest.php b/tests/phpunit/tests/privacy/wpPrivacyCompletedRequest.php
@@ -1,19 +1,13 @@
 <?php
 /**
- * Test the `_wp_privacy_completed_request()` function.
+ * Test cases for the `_wp_privacy_completed_request()` function.
  *
  * @package WordPress
  * @subpackage UnitTests
  * @since 4.9.6
- */
-
-/**
- * Tests_Privacy_wpPrivacyCompletedRequest class.
  *
  * @group privacy
  * @covers ::_wp_privacy_completed_request
- *
- * @since 4.9.6
  */
 class Tests_Privacy_wpPrivacyCompletedRequest extends WP_UnitTestCase {
 	/**

diff --git a/tests/phpunit/tests/privacy/wpPrivacyDeleteOldExportFiles.php b/tests/phpunit/tests/privacy/wpPrivacyDeleteOldExportFiles.php
@@ -1,19 +1,13 @@
 <?php
 /**
- * Define a class to test `wp_privacy_delete_old_export_files()`.
+ * Test cases for the `wp_privacy_delete_old_export_files()` function.
  *
  * @package WordPress
  * @subpackage UnitTests
  * @since 4.9.6
- */
-
-/**
- * Test cases for `wp_privacy_delete_old_export_files()`.
  *
  * @group privacy
  * @covers ::wp_privacy_delete_old_export_files
- *
- * @since 4.9.6
  */
 class Tests_Privacy_wpPrivacyDeleteOldExportFiles extends WP_UnitTestCase {
 	/**

diff --git a/tests/phpunit/tests/privacy/wpPrivacyGeneratePersonalDataExportFile.php b/tests/phpunit/tests/privacy/wpPrivacyGeneratePersonalDataExportFile.php
@@ -1,20 +1,14 @@
 <?php
 /**
- * Define a class to test `wp_privacy_generate_personal_data_export_file()`.
+ * Test cases for the `wp_privacy_generate_personal_data_export_file()` function.
  *
  * @package WordPress
  * @subpackage UnitTests
  * @since 5.2.0
- */
-
-/**
- * Test cases for `wp_privacy_generate_personal_data_export_file()`.
  *
  * @group privacy
  * @covers ::wp_privacy_generate_personal_data_export_file
  * @requires extension zip
- *
- * @since 5.2.0
  */
 class Tests_Privacy_wpPrivacyGeneratePersonalDataExportFile extends WP_UnitTestCase {
 	/**

diff --git a/tests/phpunit/tests/privacy/wpPrivacyGeneratePersonalDataExportGroupHtml.php b/tests/phpunit/tests/privacy/wpPrivacyGeneratePersonalDataExportGroupHtml.php
@@ -5,15 +5,9 @@
  * @package WordPress
  * @subpackage UnitTests
  * @since 5.2.0
- */
-
-/**
- * Tests_Privacy_wpPrivacyGeneratePersonalDataExportGroupHtml class.
  *
  * @group privacy
  * @covers ::wp_privacy_generate_personal_data_export_group_html
- *
- * @since 5.2.0
  */
 class Tests_Privacy_wpPrivacyGeneratePersonalDataExportGroupHtml extends WP_UnitTestCase {
 

diff --git a/tests/phpunit/tests/privacy/wpPrivacyProcessPersonalDataExportPage.php b/tests/phpunit/tests/privacy/wpPrivacyProcessPersonalDataExportPage.php
@@ -5,15 +5,9 @@
  * @package WordPress
  * @subpackage UnitTests
  * @since 5.2.0
- */
-
-/**
- * Tests_Privacy_wpPrivacyProcessPersonalDataExportPage class.
  *
  * @group privacy
  * @covers ::wp_privacy_process_personal_data_export_page
- *
- * @since 5.2.0
  */
 class Tests_Privacy_wpPrivacyProcessPersonalDataExportPage extends WP_UnitTestCase {
 	/**

diff --git a/tests/phpunit/tests/privacy/wpPrivacySendErasureFulfillmentNotification.php b/tests/phpunit/tests/privacy/wpPrivacySendErasureFulfillmentNotification.php
@@ -5,15 +5,9 @@
  * @package WordPress
  * @subpackage UnitTests
  * @since 5.1.0
- */
-
-/**
- * Tests_Privacy_wpPrivacySendErasureFulfillmentNotification class.
  *
  * @group privacy
  * @covers ::_wp_privacy_send_erasure_fulfillment_notification
- *
- * @since 5.1.0
  */
 class Tests_Privacy_wpPrivacySendErasureFulfillmentNotification extends WP_UnitTestCase {
 	/**

diff --git a/tests/phpunit/tests/privacy/wpPrivacySendPersonalDataExportEmail.php b/tests/phpunit/tests/privacy/wpPrivacySendPersonalDataExportEmail.php
@@ -5,15 +5,9 @@
  * @package WordPress
  * @subpackage UnitTests
  * @since 4.9.6
- */
-
-/**
- * Tests_Privacy_wpPrivacySendPersonalDataExportEmail class.
  *
  * @group privacy
  * @covers ::wp_privacy_send_personal_data_export_email
- *
- * @since 4.9.6
  */
 class Tests_Privacy_wpPrivacySendPersonalDataExportEmail extends WP_UnitTestCase {
 	/**

diff --git a/tests/phpunit/tests/privacy/wpPrivacySendRequestConfirmationNotification.php b/tests/phpunit/tests/privacy/wpPrivacySendRequestConfirmationNotification.php
@@ -5,16 +5,10 @@
  * @package WordPress
  * @subpackage UnitTests
  * @since 4.9.8
- */
-
-/**
- * Tests_Privacy_wpPrivacySendRequestConfirmationNotification class.
  *
  * @group privacy
  * @group user
  * @covers ::_wp_privacy_send_request_confirmation_notification
- *
- * @since 4.9.8
  */
 class Tests_Privacy_wpPrivacySendRequestConfirmationNotification extends WP_UnitTestCase {
 	/**

diff --git a/tests/phpunit/tests/user/wpSendUserRequest.php b/tests/phpunit/tests/user/wpSendUserRequest.php
@@ -4,12 +4,6 @@
  *
  * @package WordPress
  * @since 4.9.9
- */
-
-/**
- * Tests_User_WpSendUserRequest class.
- *
- * @since 4.9.9
  *
  * @group privacy
  * @group user