Merge pull request #224 from Yoast/feature/consistently-use-since-tags

CS/QA: always have a `@since` tag

phpunitpolyfills-autoload.php

@@ -9,12 +9,16 @@
 
 	/**
 	 * Custom autoloader.
+	 *
+	 * @since 0.1.0
 	 */
 	final class Autoload {
 
 		/**
 		 * Version number.
 		 *
+		 * @since 1.0.1
+		 *
 		 * @var string
 		 */
 		const VERSION = '1.1.2';

src/Exceptions/InvalidComparisonMethodException.php

@@ -9,6 +9,8 @@
  *
  * PHPUnit natively throws a range of different exceptions.
  * The polyfill throws just one exception type with different messages.
+ *
+ * @since 1.0.0
  */
 final class InvalidComparisonMethodException extends Exception {
 

src/Helpers/ResourceHelper.php

@@ -16,6 +16,8 @@
  * ---------------------------------------------------------------------------------------------
  *
  * @internal
+ *
+ * @since 1.0.0
  */
 final class ResourceHelper {
 

src/Polyfills/AssertClosedResource.php

@@ -14,6 +14,8 @@
  *
  * @link https://github.com/sebastianbergmann/phpunit/issues/4276
  * @link https://github.com/sebastianbergmann/phpunit/pull/4365
+ *
+ * @since 1.0.0
  */
 trait AssertClosedResource {
 

src/Polyfills/AssertClosedResource_Empty.php

@@ -10,6 +10,8 @@
  * For consistency, the "should this test be skipped" method is included
  * as the PHPUnit native versions of the `assertIs[Not]ClosedResource()`
  * assertions are affected by the same bugs.
+ *
+ * @since 1.0.0
  */
 trait AssertClosedResource {
 

src/Polyfills/AssertEqualsSpecializations.php

@@ -12,6 +12,8 @@
  * deprecated in PHPUnit 7.5.0 and removed in PHPUnit 9.0.0.
  *
  * @link https://github.com/sebastianbergmann/phpunit/issues/3340
+ *
+ * @since 0.1.0
  */
 trait AssertEqualsSpecializations {
 

src/Polyfills/AssertEqualsSpecializations_Empty.php

@@ -4,5 +4,7 @@
 
 /**
  * Empty trait for use with PHPUnit >= 7.5.0 in which this polyfill is not needed.
+ *
+ * @since 0.1.0
  */
 trait AssertEqualsSpecializations {}

src/Polyfills/AssertFileDirectory.php

@@ -15,6 +15,8 @@
  * Introduced in PHPUnit 5.6.0.
  *
  * @link https://github.com/sebastianbergmann/phpunit/pull/2262
+ *
+ * @since 0.2.0
  */
 trait AssertFileDirectory {
 

src/Polyfills/AssertFileDirectory_Empty.php

@@ -4,5 +4,7 @@
 
 /**
  * Empty trait for use with PHPUnit >= 5.6.0 in which this polyfill is not needed.
+ *
+ * @since 0.2.0
  */
 trait AssertFileDirectory {}

src/Polyfills/AssertFileEqualsSpecializations.php

@@ -15,6 +15,8 @@
  *
  * @link https://github.com/sebastianbergmann/phpunit/issues/3949
  * @link https://github.com/sebastianbergmann/phpunit/issues/3951
+ *
+ * @since 0.1.0
  */
 trait AssertFileEqualsSpecializations {
 

src/Polyfills/AssertFileEqualsSpecializations_Empty.php

@@ -4,5 +4,7 @@
 
 /**
  * Empty trait for use with PHPUnit >= 8.5.0 in which this polyfill is not needed.
+ *
+ * @since 0.1.0
  */
 trait AssertFileEqualsSpecializations {}

src/Polyfills/AssertIsType.php

@@ -14,6 +14,8 @@
  *
  * @link https://github.com/sebastianbergmann/phpunit/issues/3368
  * @link https://github.com/sebastianbergmann/phpunit/issues/3369
+ *
+ * @since 0.1.0
  */
 trait AssertIsType {
 

src/Polyfills/AssertIsType_Empty.php

@@ -4,5 +4,7 @@
 
 /**
  * Empty trait for use with PHPUnit >= 7.5.0 in which this polyfill is not needed.
+ *
+ * @since 0.1.0
  */
 trait AssertIsType {}

src/Polyfills/AssertNumericType.php

@@ -8,6 +8,8 @@
  * Introduced in PHPUnit 5.0.0.
  *
  * @link https://github.com/sebastianbergmann/phpunit/pull/1753
+ *
+ * @since 0.2.0
  */
 trait AssertNumericType {
 

src/Polyfills/AssertNumericType_Empty.php

@@ -4,5 +4,7 @@
 
 /**
  * Empty trait for use with PHPUnit >= 5.0.0 in which this polyfill is not needed.
+ *
+ * @since 0.2.0
  */
 trait AssertNumericType {}

src/Polyfills/AssertObjectEquals.php

@@ -22,6 +22,8 @@
  * @link https://github.com/sebastianbergmann/phpunit/issues/4707
  * @link https://github.com/sebastianbergmann/phpunit/commit/1dba8c3a4b2dd04a3ff1869f75daaeb6757a14ee
  * @link https://github.com/sebastianbergmann/phpunit/commit/6099c5eefccfda860c889f575d58b5fe6cc10c83
+ *
+ * @since 1.0.0
  */
 trait AssertObjectEquals {
 

src/Polyfills/AssertObjectEquals_Empty.php

@@ -4,5 +4,7 @@
 
 /**
  * Empty trait for use with PHPUnit >= 9.4.0 in which this polyfill is not needed.
+ *
+ * @since 1.0.0
  */
 trait AssertObjectEquals {}

src/Polyfills/AssertStringContains.php

@@ -19,6 +19,8 @@
  * @link https://github.com/sebastianbergmann/phpunit/issues/3422
  * @link https://github.com/sebastianbergmann/phpunit/issues/2520
  * @link https://github.com/sebastianbergmann/phpunit/pull/2778
+ *
+ * @since 0.1.0
  */
 trait AssertStringContains {
 

src/Polyfills/AssertStringContains_Empty.php

@@ -4,5 +4,7 @@
 
 /**
  * Empty trait for use with PHPUnit >= 7.5.0 in which this polyfill is not needed.
+ *
+ * @since 0.1.0
  */
 trait AssertStringContains {}

src/Polyfills/AssertionRenames.php

@@ -38,6 +38,8 @@
  * @link https://github.com/sebastianbergmann/phpunit/issues/4088
  * @link https://github.com/sebastianbergmann/phpunit/issues/4089
  * @link https://github.com/sebastianbergmann/phpunit/issues/4090
+ *
+ * @since 0.1.0
  */
 trait AssertionRenames {
 

src/Polyfills/AssertionRenames_Empty.php

@@ -4,5 +4,7 @@
 
 /**
  * Empty trait for use with PHPUnit >= 9.1.0 in which this polyfill is not needed.
+ *
+ * @since 0.1.0
  */
 trait AssertionRenames {}

src/Polyfills/EqualToSpecializations.php

@@ -15,6 +15,8 @@
  * never deprecated but leads to unexpected behaviour as they are ignored in PHPUnit 9.0.0.
  *
  * @link https://github.com/sebastianbergmann/phpunit/commit/43c01a4e0c74a4bf019a8d879bced5146af2fbb6
+ *
+ * @since 1.0.0
  */
 trait EqualToSpecializations {
 

src/Polyfills/EqualToSpecializations_Empty.php

@@ -4,5 +4,7 @@
 
 /**
  * Empty trait for use with PHPUnit >= 9.0.0 in which this polyfill is not needed.
+ *
+ * @since 1.0.0
  */
 trait EqualToSpecializations {}

src/Polyfills/ExpectException.php

@@ -20,6 +20,8 @@
  *
  * @link https://github.com/sebastianbergmann/phpunit/commit/55d97d56696d5f6dee02732c08212ec519057803
  * @link https://github.com/sebastianbergmann/phpunit/commit/13305a6183ede02fc5d2f3534a93efac852813d5
+ *
+ * @since 0.2.0
  */
 trait ExpectException {
 

src/Polyfills/ExpectExceptionMessageMatches.php

@@ -13,6 +13,8 @@
  * @link https://github.com/sebastianbergmann/phpunit/commit/d1199cb2e43a934b51521656be9748f63febe18e
  * @link https://github.com/sebastianbergmann/phpunit/issues/4133
  * @link https://github.com/sebastianbergmann/phpunit/issues/3957
+ *
+ * @since 0.1.0
  */
 trait ExpectExceptionMessageMatches {
 

src/Polyfills/ExpectExceptionMessageMatches_Empty.php

@@ -4,5 +4,7 @@
 
 /**
  * Empty trait for use with PHPUnit >= 8.4.0 in which this polyfill is not needed.
+ *
+ * @since 0.1.0
  */
 trait ExpectExceptionMessageMatches {}

src/Polyfills/ExpectExceptionObject.php

@@ -10,6 +10,8 @@
  * Introduced in PHPUnit 6.4.0.
  *
  * @link https://github.com/sebastianbergmann/phpunit/pull/2780
+ *
+ * @since 0.1.0
  */
 trait ExpectExceptionObject {
 

src/Polyfills/ExpectExceptionObject_Empty.php

@@ -4,5 +4,7 @@
 
 /**
  * Empty trait for use with PHPUnit >= 6.4.0 in which this polyfill is not needed.
+ *
+ * @since 0.1.0
  */
 trait ExpectExceptionObject {}

src/Polyfills/ExpectException_Empty.php

@@ -4,5 +4,7 @@
 
 /**
  * Empty trait for use with PHPUnit >= 5.2.0 in which this polyfill is not needed.
+ *
+ * @since 0.2.0
  */
 trait ExpectException {}

src/Polyfills/ExpectPHPException.php

@@ -14,6 +14,8 @@
  * @link https://github.com/sebastianbergmann/phpunit/issues/3775
  * @link https://github.com/sebastianbergmann/phpunit/issues/3776
  * @link https://github.com/sebastianbergmann/phpunit/issues/3777
+ *
+ * @since 0.1.0
  */
 trait ExpectPHPException {
 

src/Polyfills/ExpectPHPException_Empty.php

@@ -4,5 +4,7 @@
 
 /**
  * Empty trait for use with PHPUnit >= 8.4.0 in which this polyfill is not needed.
+ *
+ * @since 0.1.0
  */
 trait ExpectPHPException {}

src/TestCases/TestCasePHPUnitGte8.php

@@ -21,6 +21,8 @@
  * methods to get round the signature change in PHPUnit 8.
  *
  * When using this TestCase, the snakecase method names need to be used to overload a fixture method.
+ *
+ * @since 0.1.0
  */
 abstract class TestCase extends PHPUnit_TestCase {
 
@@ -63,6 +65,8 @@ protected function setUp(): void {
 	 *
 	 * This method is called before the execution of a test starts and after setUp() is called.
 	 *
+	 * @since 0.2.0
+	 *
 	 * @return void
 	 */
 	protected function assertPreConditions(): void {
@@ -75,6 +79,8 @@ protected function assertPreConditions(): void {
 	 *
 	 * This method is called before the execution of a test ends and before tearDown() is called.
 	 *
+	 * @since 0.2.0
+	 *
 	 * @return void
 	 */
 	protected function assertPostConditions(): void {

src/TestCases/TestCasePHPUnitLte7.php

@@ -28,6 +28,8 @@
  * methods to get round the signature change in PHPUnit 8.
  *
  * When using this TestCase, the snakecase method names need to be used to overload a fixture method.
+ *
+ * @since 0.1.0
  */
 abstract class TestCase extends PHPUnit_TestCase {
 
@@ -77,6 +79,8 @@ protected function setUp() {
 	 *
 	 * This method is called before the execution of a test starts and after setUp() is called.
 	 *
+	 * @since 0.2.0
+	 *
 	 * @return void
 	 */
 	protected function assertPreConditions() {
@@ -89,6 +93,8 @@ protected function assertPreConditions() {
 	 *
 	 * This method is called before the execution of a test ends and before tearDown() is called.
 	 *
+	 * @since 0.2.0
+	 *
 	 * @return void
 	 */
 	protected function assertPostConditions() {

src/TestCases/XTestCase.php

@@ -30,6 +30,8 @@
  * `@after` and `@afterClass` annotations.
  * The naming of the overloaded methods is open as long as the method names don't conflict with
  * the PHPUnit native method names.
+ *
+ * @since 0.1.0
  */
 abstract class XTestCase extends PHPUnit_TestCase {
 

src/TestListeners/TestListenerDefaultImplementationPHPUnit6.php

@@ -16,6 +16,8 @@
  *
  * When using this TestListener trait, the snake_case method names need to be used to implement
  * the listener functionality.
+ *
+ * @since 0.2.0
  */
 trait TestListenerDefaultImplementation {
 

src/TestListeners/TestListenerDefaultImplementationPHPUnitGte7.php

@@ -16,6 +16,8 @@
  *
  * When using this TestListener trait, the snake_case method names need to be used to implement
  * the listener functionality.
+ *
+ * @since 0.2.0
  */
 trait TestListenerDefaultImplementation {
 

src/TestListeners/TestListenerDefaultImplementationPHPUnitLte5.php

@@ -22,6 +22,8 @@
  * file are based on the namespaced names. As both the namespaced names as well as the
  * non-namespaced names exist in PHPUnit 4.8.36+/5.7.21+, we cannot create class aliases to
  * get round the signature mismatch and need this trait using the old names instead.}
+ *
+ * @since 0.2.0
  */
 trait TestListenerDefaultImplementation {
 

src/TestListeners/TestListenerSnakeCaseMethods.php

@@ -12,6 +12,8 @@
 /**
  * Renamed snake_case TestListener method collection used by the TestListenerDefaultImplementation traits.
  *
+ * @since 0.2.0
+ *
  * @phpcs:disable VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable -- This is intentional as these are template methods.
  */
 trait TestListenerSnakeCaseMethods {