Remove file docblocks

They serve no purpose; we have the class docblocks
cweiske · Jul 20, 2024 · 7d6aacd · 7d6aacd
1 parent 155cf24
commit 7d6aacd
Show file tree

Hide file tree

Showing 17 changed files with 3 additions and 179 deletions.
diff --git a/phpcs.xml b/phpcs.xml
@@ -3,7 +3,9 @@
     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
     xsi:noNamespaceSchemaLocation="phpcs.xsd">
 
-    <rule ref="PEAR"/>
+    <rule ref="PEAR">
+        <exclude name="PEAR.Commenting.FileComment.Missing"/>
+    </rule>
     <rule ref="Generic.Files.LineLength">
         <properties>
             <property name="lineLimit" value="100"/>

diff --git a/src/JsonMapper.php b/src/JsonMapper.php
@@ -1,16 +1,4 @@
 <?php
-/**
- * Part of JsonMapper
- *
- * PHP version 5
- *
- * @category Netresearch
- * @package  JsonMapper
- * @author   Christian Weiske <[email protected]>
- * @license  OSL-3.0 http://opensource.org/licenses/osl-3.0
- * @link     http://cweiske.de/
- */
-
 /**
  * Automatically map JSON structures into objects.
  *

diff --git a/src/JsonMapper/Exception.php b/src/JsonMapper/Exception.php
@@ -1,16 +1,4 @@
 <?php
-/**
- * Part of JsonMapper
- *
- * PHP version 5
- *
- * @category Netresearch
- * @package  JsonMapper
- * @author   Christian Weiske <[email protected]>
- * @license  OSL-3.0 http://opensource.org/licenses/osl-3.0
- * @link     http://cweiske.de/
- */
-
 /**
  * Simple exception
  *

diff --git a/tests/ArrayTest.php b/tests/ArrayTest.php
@@ -1,16 +1,4 @@
 <?php
-/**
- * Part of JsonMapper
- *
- * PHP version 5
- *
- * @category Tools
- * @package  JsonMapper
- * @author   Christian Weiske <[email protected]>
- * @license  OSL-3.0 http://opensource.org/licenses/osl-3.0
- * @link     https://github.com/cweiske/jsonmapper
- */
-
 use namespacetest\model\MyArrayObject;
 
 /**

diff --git a/tests/ClassMapTest.php b/tests/ClassMapTest.php
@@ -1,16 +1,4 @@
 <?php
-/**
- * Part of JsonMapper
- *
- * PHP version 5
- *
- * @category Tools
- * @package  JsonMapper
- * @author   Christian Weiske <[email protected]>
- * @license  OSL-3.0 http://opensource.org/licenses/osl-3.0
- * @link     https://github.com/cweiske/jsonmapper
- */
-
 /**
  * Unit tests for JsonMapper's classMap
  *

diff --git a/tests/EventTest.php b/tests/EventTest.php
@@ -1,16 +1,4 @@
 <?php
-/**
- * Part of JsonMapper
- *
- * PHP version 5
- *
- * @category Tools
- * @package  JsonMapper
- * @author   Christian Weiske <[email protected]>
- * @license  OSL-3.0 http://opensource.org/licenses/osl-3.0
- * @link     https://github.com/cweiske/jsonmapper
- */
-
 use PHPUnit\Framework\TestCase;
 
 /**

diff --git a/tests/ObjectTest.php b/tests/ObjectTest.php
@@ -1,16 +1,4 @@
 <?php
-/**
- * Part of JsonMapper
- *
- * PHP version 5
- *
- * @category Tools
- * @package  JsonMapper
- * @author   Christian Weiske <[email protected]>
- * @license  OSL-3.0 http://opensource.org/licenses/osl-3.0
- * @link     https://github.com/cweiske/jsonmapper
- */
-
 /**
  * Unit tests for JsonMapper's object handling
  *

diff --git a/tests/OtherTest.php b/tests/OtherTest.php
@@ -1,15 +1,4 @@
 <?php
-/**
- * Part of JsonMapper
- *
- * PHP version 5
- *
- * @package  JsonMapper
- * @author   Christian Weiske <[email protected]>
- * @license  OSL-3.0 http://opensource.org/licenses/osl-3.0
- * @link     http://cweiske.de/
- */
-
 /**
  * Unit tests for JsonMapper that don't fit in other categories
  *

diff --git a/tests/RemoveUndefinedAttributesTest.php b/tests/RemoveUndefinedAttributesTest.php
@@ -1,15 +1,4 @@
 <?php
-/**
- * Part of JsonMapper
- *
- * PHP version 5
- *
- * @package  JsonMapper
- * @author   Christian Weiske <[email protected]>
- * @license  OSL-3.0 http://opensource.org/licenses/osl-3.0
- * @link     http://cweiske.de/
- */
-
 /**
  * Unit tests for JsonMapper option "bRemoveUndefinedAttributes".
  *

diff --git a/tests/SimpleTest.php b/tests/SimpleTest.php
@@ -1,16 +1,4 @@
 <?php
-/**
- * Part of JsonMapper
- *
- * PHP version 5
- *
- * @category Tools
- * @package  JsonMapper
- * @author   Christian Weiske <[email protected]>
- * @license  OSL-3.0 http://opensource.org/licenses/osl-3.0
- * @link     https://github.com/cweiske/jsonmapper
- */
-
 /**
  * Unit tests for JsonMapper's simple type handling
  *

diff --git a/tests/support/JsonMapperTest/Array.php b/tests/support/JsonMapperTest/Array.php
@@ -1,15 +1,4 @@
 <?php
-/**
- * Part of JsonMapper
- *
- * PHP version 5
- *
- * @package  JsonMapper
- * @author   Christian Weiske <[email protected]>
- * @license  OSL-3.0 http://opensource.org/licenses/osl-3.0
- * @link     http://cweiske.de/
- */
-
 /**
  * Unit test helper class for testing property mapping
  *

diff --git a/tests/support/JsonMapperTest/ArrayValueForStringProperty.php b/tests/support/JsonMapperTest/ArrayValueForStringProperty.php
@@ -1,15 +1,4 @@
 <?php
-/**
- * Part of JsonMapper
- *
- * PHP version 5
- *
- * @package  JsonMapper
- * @author   Christian Weiske <[email protected]>
- * @license  OSL-3.0 http://opensource.org/licenses/osl-3.0
- * @link     http://cweiske.de/
- */
-
 class JsonMapperTest_ArrayValueForStringProperty
 {
 	public string $value;

diff --git a/tests/support/JsonMapperTest/Broken.php b/tests/support/JsonMapperTest/Broken.php
@@ -1,15 +1,4 @@
 <?php
-/**
- * Part of JsonMapper
- *
- * PHP version 5
- *
- * @package  JsonMapper
- * @author   Christian Weiske <[email protected]>
- * @license  OSL-3.0 http://opensource.org/licenses/osl-3.0
- * @link     http://cweiske.de/
- */
-
 /**
  * Unit test helper class for testing property mapping
  *

diff --git a/tests/support/JsonMapperTest/ComplexObject.php b/tests/support/JsonMapperTest/ComplexObject.php
@@ -1,11 +1,4 @@
 <?php
-/**
- * Created by PhpStorm.
- * User: jaredchu
- * Date: 11/08/2017
- * Time: 16:39
- */
-
 class JsonMapperTest_ComplexObject
 {
     /**

diff --git a/tests/support/JsonMapperTest/Logger.php b/tests/support/JsonMapperTest/Logger.php
@@ -1,15 +1,4 @@
 <?php
-/**
- * Part of JsonMapper
- *
- * PHP version 5
- *
- * @package  JsonMapper
- * @author   Christian Weiske <[email protected]>
- * @license  OSL-3.0 http://opensource.org/licenses/osl-3.0
- * @link     http://cweiske.de/
- */
-
 /**
  * Simple in-memory logger
  *

diff --git a/tests/support/JsonMapperTest/Simple.php b/tests/support/JsonMapperTest/Simple.php
@@ -1,15 +1,4 @@
 <?php
-/**
- * Part of JsonMapper
- *
- * PHP version 5
- *
- * @package  JsonMapper
- * @author   Christian Weiske <[email protected]>
- * @license  OSL-3.0 http://opensource.org/licenses/osl-3.0
- * @link     http://cweiske.de/
- */
-
 /**
  * Unit test helper class for testing property mapping
  *

diff --git a/tests/support/JsonMapperTest/VariadicArray.php b/tests/support/JsonMapperTest/VariadicArray.php
@@ -1,14 +1,4 @@
 <?php
-/**
- * Part of JsonMapper
- *
- * PHP version 5
- *
- * @package  JsonMapper
- * @author   Christian Weiske <[email protected]>
- * @license  OSL-3.0 http://opensource.org/licenses/osl-3.0
- * @link     http://cweiske.de/
- */
 
 /**
  * Unit test helper class for testing property mapping