Remove @category from src/ docblocks

cweiske · cweiske · commit e6521833f688 · 2024-07-21T10:39:00.000+02:00
They serve no purpose. Also, use "@category Tests" for unittests
diff --git a/phpcs.xml b/phpcs.xml
@@ -5,6 +5,7 @@
 
     <rule ref="PEAR">
         <exclude name="PEAR.Commenting.FileComment.Missing"/>
+        <exclude name="PEAR.Commenting.ClassComment.MissingCategoryTag"/>
     </rule>
     <rule ref="Generic.Files.LineLength">
         <properties>
diff --git a/src/JsonMapper.php b/src/JsonMapper.php
@@ -2,11 +2,10 @@
 /**
  * Automatically map JSON structures into objects.
  *
- * @category Netresearch
- * @package  JsonMapper
- * @author   Christian Weiske <cweiske@cweiske.de>
- * @license  OSL-3.0 http://opensource.org/licenses/osl-3.0
- * @link     http://cweiske.de/
+ * @package JsonMapper
+ * @author  Christian Weiske <cweiske@cweiske.de>
+ * @license OSL-3.0 http://opensource.org/licenses/osl-3.0
+ * @link    http://cweiske.de/
  */
 class JsonMapper
 {
diff --git a/src/JsonMapper/Exception.php b/src/JsonMapper/Exception.php
@@ -2,11 +2,10 @@
 /**
  * Simple exception
  *
- * @category Netresearch
- * @package  JsonMapper
- * @author   Christian Weiske <cweiske@cweiske.de>
- * @license  OSL-3.0 http://opensource.org/licenses/osl-3.0
- * @link     http://cweiske.de/
+ * @package JsonMapper
+ * @author  Christian Weiske <cweiske@cweiske.de>
+ * @license OSL-3.0 http://opensource.org/licenses/osl-3.0
+ * @link    http://cweiske.de/
  */
 class JsonMapper_Exception extends Exception
 {
diff --git a/tests/ArrayTest.php b/tests/ArrayTest.php
@@ -4,7 +4,7 @@
 /**
  * Unit tests for JsonMapper's array handling
  *
- * @category Tools
+ * @category Tests
  * @package  JsonMapper
  * @author   Christian Weiske <cweiske@cweiske.de>
  * @license  OSL-3.0 http://opensource.org/licenses/osl-3.0
diff --git a/tests/Array_PHP74_Test.php b/tests/Array_PHP74_Test.php
@@ -7,7 +7,7 @@
 /**
  * Unit tests for JsonMapper's support for PHP 7.4 typed arrays
  *
- * @category Tools
+ * @category Tests
  * @package  JsonMapper
  * @author   Martin Reinfandt <martin.reinfandt@check24.de>
  * @license  OSL-3.0 http://opensource.org/licenses/osl-3.0
diff --git a/tests/Array_PHP80_Test.php b/tests/Array_PHP80_Test.php
@@ -7,7 +7,7 @@
 /**
  * Unit tests for JsonMapper's support for PHP 8.0 typed arrays for properties with constructor promotion
  *
- * @category Tools
+ * @category Tests
  * @package  JsonMapper
  * @author   Andreas Wunderwald <wundii@gmail.com>
  * @license  OSL-3.0 http://opensource.org/licenses/osl-3.0
diff --git a/tests/ClassMapTest.php b/tests/ClassMapTest.php
@@ -2,7 +2,7 @@
 /**
  * Unit tests for JsonMapper's classMap
  *
- * @category Tools
+ * @category Tests
  * @package  JsonMapper
  * @author   Christian Weiske <cweiske@cweiske.de>
  * @license  OSL-3.0 http://opensource.org/licenses/osl-3.0
diff --git a/tests/Enums_PHP81_Test.php b/tests/Enums_PHP81_Test.php
@@ -5,7 +5,7 @@
 /**
  * Unit tests for JsonMapper's support for PHP 8.1 enums
  *
- * @category Tools
+ * @category Tests
  * @package  JsonMapper
  * @author   Martin Reinfandt <martin.reinfandt@check24.de>
  * @license  OSL-3.0 http://opensource.org/licenses/osl-3.0
diff --git a/tests/EventTest.php b/tests/EventTest.php
@@ -4,7 +4,7 @@
 /**
  * Unit tests for JsonMapper's object handling (events)
  *
- * @category Tools
+ * @category Tests
  * @package  JsonMapper
  * @author   Christian Weiske <cweiske@cweiske.de>
  * @license  OSL-3.0 http://opensource.org/licenses/osl-3.0
diff --git a/tests/MixedType_PHP80_Test.php b/tests/MixedType_PHP80_Test.php
@@ -3,7 +3,7 @@
 /**
  * Unit tests for JsonMapper's support for PHP 8.0 mixed type
  *
- * @category Tools
+ * @category Tests
  * @package  JsonMapper
  * @author   Lukas Cerny <lukas.cerny@futuretek.cz>
  * @license  OSL-3.0 http://opensource.org/licenses/osl-3.0
diff --git a/tests/ObjectTest.php b/tests/ObjectTest.php
@@ -2,7 +2,7 @@
 /**
  * Unit tests for JsonMapper's object handling
  *
- * @category Tools
+ * @category Tests
  * @package  JsonMapper
  * @author   Christian Weiske <cweiske@cweiske.de>
  * @license  OSL-3.0 http://opensource.org/licenses/osl-3.0
diff --git a/tests/OtherTest.php b/tests/OtherTest.php
@@ -2,6 +2,7 @@
 /**
  * Unit tests for JsonMapper that don't fit in other categories
  *
+ * @category Tests
  * @package  JsonMapper
  * @author   Christian Weiske <cweiske@cweiske.de>
  * @license  OSL-3.0 http://opensource.org/licenses/osl-3.0
diff --git a/tests/RemoveUndefinedAttributesTest.php b/tests/RemoveUndefinedAttributesTest.php
@@ -2,6 +2,7 @@
 /**
  * Unit tests for JsonMapper option "bRemoveUndefinedAttributes".
  *
+ * @category Tests
  * @package  JsonMapper
  * @author   Christian Weiske <cweiske@cweiske.de>
  * @license  OSL-3.0 http://opensource.org/licenses/osl-3.0
diff --git a/tests/SimpleTest.php b/tests/SimpleTest.php
@@ -2,7 +2,7 @@
 /**
  * Unit tests for JsonMapper's simple type handling
  *
- * @category Tools
+ * @category Tests
  * @package  JsonMapper
  * @author   Christian Weiske <cweiske@cweiske.de>
  * @license  OSL-3.0 http://opensource.org/licenses/osl-3.0
diff --git a/tests/StrictTypes_PHP74_Test.php b/tests/StrictTypes_PHP74_Test.php
@@ -3,7 +3,7 @@
 /**
  * Unit tests for JsonMapper's support for PHP 7.4 strict types
  *
- * @category Tools
+ * @category Tests
  * @package  JsonMapper
  * @author   Lukas Cerny <lukas.cerny@futuretek.cz>
  * @license  OSL-3.0 http://opensource.org/licenses/osl-3.0
diff --git a/tests/UnionTypesTest.php b/tests/UnionTypesTest.php
@@ -3,7 +3,7 @@
 /**
  * Unit tests for JsonMapper's union type handling
  *
- * @category Tools
+ * @category Tests
  * @package  JsonMapper
  * @author   Christian Weiske <cweiske@cweiske.de>
  * @license  OSL-3.0 http://opensource.org/licenses/osl-3.0

Original file line number	Diff line number	Diff line change
`@@ -4,7 +4,7 @@`
`4`	`4`	`/**`
`5`	`5`	`* Unit tests for JsonMapper's array handling`
`6`	`6`	`*`
`7`		`- * @category Tools`
	`7`	`+ * @category Tests`
`8`	`8`	`* @package JsonMapper`
`9`	`9`	`* @author Christian Weiske <cweiske@cweiske.de>`
`10`	`10`	`* @license OSL-3.0 http://opensource.org/licenses/osl-3.0`
Original file line number	Diff line number	Diff line change
`@@ -7,7 +7,7 @@`
`7`	`7`	`/**`
`8`	`8`	`* Unit tests for JsonMapper's support for PHP 7.4 typed arrays`
`9`	`9`	`*`
`10`		`- * @category Tools`
	`10`	`+ * @category Tests`
`11`	`11`	`* @package JsonMapper`
`12`	`12`	`* @author Martin Reinfandt <martin.reinfandt@check24.de>`
`13`	`13`	`* @license OSL-3.0 http://opensource.org/licenses/osl-3.0`
Original file line number	Diff line number	Diff line change
`@@ -2,7 +2,7 @@`
`2`	`2`	`/**`
`3`	`3`	`* Unit tests for JsonMapper's classMap`
`4`	`4`	`*`
`5`		`- * @category Tools`
	`5`	`+ * @category Tests`
`6`	`6`	`* @package JsonMapper`
`7`	`7`	`* @author Christian Weiske <cweiske@cweiske.de>`
`8`	`8`	`* @license OSL-3.0 http://opensource.org/licenses/osl-3.0`
Original file line number	Diff line number	Diff line change
`@@ -5,7 +5,7 @@`
`5`	`5`	`/**`
`6`	`6`	`* Unit tests for JsonMapper's support for PHP 8.1 enums`
`7`	`7`	`*`
`8`		`- * @category Tools`
	`8`	`+ * @category Tests`
`9`	`9`	`* @package JsonMapper`
`10`	`10`	`* @author Martin Reinfandt <martin.reinfandt@check24.de>`
`11`	`11`	`* @license OSL-3.0 http://opensource.org/licenses/osl-3.0`
Original file line number	Diff line number	Diff line change
`@@ -4,7 +4,7 @@`
`4`	`4`	`/**`
`5`	`5`	`* Unit tests for JsonMapper's object handling (events)`
`6`	`6`	`*`
`7`		`- * @category Tools`
	`7`	`+ * @category Tests`
`8`	`8`	`* @package JsonMapper`
`9`	`9`	`* @author Christian Weiske <cweiske@cweiske.de>`
`10`	`10`	`* @license OSL-3.0 http://opensource.org/licenses/osl-3.0`
Original file line number	Diff line number	Diff line change
`@@ -3,7 +3,7 @@`
`3`	`3`	`/**`
`4`	`4`	`* Unit tests for JsonMapper's support for PHP 8.0 mixed type`
`5`	`5`	`*`
`6`		`- * @category Tools`
	`6`	`+ * @category Tests`
`7`	`7`	`* @package JsonMapper`
`8`	`8`	`* @author Lukas Cerny <lukas.cerny@futuretek.cz>`
`9`	`9`	`* @license OSL-3.0 http://opensource.org/licenses/osl-3.0`
Original file line number	Diff line number	Diff line change
`@@ -2,6 +2,7 @@`
`2`	`2`	`/**`
`3`	`3`	`* Unit tests for JsonMapper that don't fit in other categories`
`4`	`4`	`*`
	`5`	`+ * @category Tests`
`5`	`6`	`* @package JsonMapper`
`6`	`7`	`* @author Christian Weiske <cweiske@cweiske.de>`
`7`	`8`	`* @license OSL-3.0 http://opensource.org/licenses/osl-3.0`
Original file line number	Diff line number	Diff line change
`@@ -2,6 +2,7 @@`
`2`	`2`	`/**`
`3`	`3`	`* Unit tests for JsonMapper option "bRemoveUndefinedAttributes".`
`4`	`4`	`*`
	`5`	`+ * @category Tests`
`5`	`6`	`* @package JsonMapper`
`6`	`7`	`* @author Christian Weiske <cweiske@cweiske.de>`
`7`	`8`	`* @license OSL-3.0 http://opensource.org/licenses/osl-3.0`
Original file line number	Diff line number	Diff line change
`@@ -2,7 +2,7 @@`
`2`	`2`	`/**`
`3`	`3`	`* Unit tests for JsonMapper's simple type handling`
`4`	`4`	`*`
`5`		`- * @category Tools`
	`5`	`+ * @category Tests`
`6`	`6`	`* @package JsonMapper`
`7`	`7`	`* @author Christian Weiske <cweiske@cweiske.de>`
`8`	`8`	`* @license OSL-3.0 http://opensource.org/licenses/osl-3.0`
Original file line number	Diff line number	Diff line change
`@@ -3,7 +3,7 @@`
`3`	`3`	`/**`
`4`	`4`	`* Unit tests for JsonMapper's union type handling`
`5`	`5`	`*`
`6`		`- * @category Tools`
	`6`	`+ * @category Tests`
`7`	`7`	`* @package JsonMapper`
`8`	`8`	`* @author Christian Weiske <cweiske@cweiske.de>`
`9`	`9`	`* @license OSL-3.0 http://opensource.org/licenses/osl-3.0`