Remove @category from src/ docblocks

They serve no purpose. Also, use "@category Tests" for unittests
cweiske · Jul 21, 2024 · e652183 · e652183
1 parent 7d6aacd
commit e652183
Show file tree

Hide file tree

Showing 16 changed files with 22 additions and 21 deletions.
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 <[email protected]>
- * @license  OSL-3.0 http://opensource.org/licenses/osl-3.0
- * @link     http://cweiske.de/
+ * @package JsonMapper
+ * @author  Christian Weiske <[email protected]>
+ * @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 <[email protected]>
- * @license  OSL-3.0 http://opensource.org/licenses/osl-3.0
- * @link     http://cweiske.de/
+ * @package JsonMapper
+ * @author  Christian Weiske <[email protected]>
+ * @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 <[email protected]>
  * @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 <[email protected]>
  * @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 <[email protected]>
  * @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 <[email protected]>
  * @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 <[email protected]>
  * @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 <[email protected]>
  * @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 <[email protected]>
  * @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 <[email protected]>
  * @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 <[email protected]>
  * @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 <[email protected]>
  * @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 <[email protected]>
  * @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 <[email protected]>
  * @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 <[email protected]>
  * @license  OSL-3.0 http://opensource.org/licenses/osl-3.0