Remove auto-generated @param-only PHPDoc blocks that add zero information

thiemowmde · thiemowmde · commit 231208312ec8 · 2017-06-26T11:54:45.000+02:00
This patch removes auto-generated PHPDoc blocks that contain nothing but a sequence of @param lines that *literally* repeat what the function header below contains. These blocks add zero additional information, but clutter the code and need to be maintained. This patch does not touch PHPDoc blocks when one of the @param lines contains an actual comment behind the variable name, or when one of the types is not a class name. See https://gerrit.wikimedia.org/r/360814 for the same patch in the Wikibase.git code base.
diff --git a/.travis.yml b/.travis.yml
@@ -1,5 +1,7 @@
 language: php
 
+dist: trusty
+
 matrix:
   fast_finish: true
   include:
diff --git a/src/Deserializers/EntityIdDeserializer.php b/src/Deserializers/EntityIdDeserializer.php
@@ -21,9 +21,6 @@ class EntityIdDeserializer implements Deserializer {
 	 */
 	private $entityIdParser;
 
-	/**
-	 * @param EntityIdParser $entityIdParser
-	 */
 	public function __construct( EntityIdParser $entityIdParser ) {
 		$this->entityIdParser = $entityIdParser;
 	}
diff --git a/src/Deserializers/ItemDeserializer.php b/src/Deserializers/ItemDeserializer.php
@@ -47,13 +47,6 @@ class ItemDeserializer extends TypedObjectDeserializer {
 	 */
 	private $siteLinkDeserializer;
 
-	/**
-	 * @param Deserializer $entityIdDeserializer
-	 * @param Deserializer $termListDeserializer
-	 * @param Deserializer $aliasGroupListDeserializer
-	 * @param Deserializer $statementListDeserializer
-	 * @param Deserializer $siteLinkDeserializer
-	 */
 	public function __construct(
 		Deserializer $entityIdDeserializer,
 		Deserializer $termListDeserializer,
diff --git a/src/Deserializers/PropertyDeserializer.php b/src/Deserializers/PropertyDeserializer.php
@@ -40,12 +40,6 @@ class PropertyDeserializer extends TypedObjectDeserializer {
 	 */
 	private $statementListDeserializer;
 
-	/**
-	 * @param Deserializer $entityIdDeserializer
-	 * @param Deserializer $termListDeserializer
-	 * @param Deserializer $aliasGroupListDeserializer
-	 * @param Deserializer $statementListDeserializer
-	 */
 	public function __construct(
 		Deserializer $entityIdDeserializer,
 		Deserializer $termListDeserializer,
diff --git a/src/Deserializers/ReferenceDeserializer.php b/src/Deserializers/ReferenceDeserializer.php
@@ -22,9 +22,6 @@ class ReferenceDeserializer implements DispatchableDeserializer {
 	 */
 	private $snaksDeserializer;
 
-	/**
-	 * @param Deserializer $snaksDeserializer
-	 */
 	public function __construct( Deserializer $snaksDeserializer ) {
 		$this->snaksDeserializer = $snaksDeserializer;
 	}
diff --git a/src/Deserializers/ReferenceListDeserializer.php b/src/Deserializers/ReferenceListDeserializer.php
@@ -20,9 +20,6 @@ class ReferenceListDeserializer implements Deserializer {
 	 */
 	private $referenceDeserializer;
 
-	/**
-	 * @param Deserializer $referenceDeserializer
-	 */
 	public function __construct( Deserializer $referenceDeserializer ) {
 		$this->referenceDeserializer = $referenceDeserializer;
 	}
diff --git a/src/Deserializers/SiteLinkDeserializer.php b/src/Deserializers/SiteLinkDeserializer.php
@@ -22,9 +22,6 @@ class SiteLinkDeserializer implements Deserializer {
 	 */
 	private $entityIdDeserializer;
 
-	/**
-	 * @param Deserializer $entityIdDeserializer
-	 */
 	public function __construct( Deserializer $entityIdDeserializer ) {
 		$this->entityIdDeserializer = $entityIdDeserializer;
 	}
diff --git a/src/Deserializers/SnakDeserializer.php b/src/Deserializers/SnakDeserializer.php
@@ -34,10 +34,6 @@ class SnakDeserializer implements DispatchableDeserializer {
 	 */
 	private $entityIdDeserializer;
 
-	/**
-	 * @param Deserializer $dataValueDeserializer
-	 * @param Deserializer $entityIdDeserializer
-	 */
 	public function __construct(
 		Deserializer $dataValueDeserializer,
 		Deserializer $entityIdDeserializer
diff --git a/src/Deserializers/SnakListDeserializer.php b/src/Deserializers/SnakListDeserializer.php
@@ -21,9 +21,6 @@ class SnakListDeserializer implements Deserializer {
 	 */
 	private $snakDeserializer;
 
-	/**
-	 * @param Deserializer $snakDeserializer
-	 */
 	public function __construct( Deserializer $snakDeserializer ) {
 		$this->snakDeserializer = $snakDeserializer;
 	}
diff --git a/src/Deserializers/StatementListDeserializer.php b/src/Deserializers/StatementListDeserializer.php
@@ -21,9 +21,6 @@ class StatementListDeserializer implements Deserializer {
 	 */
 	private $statementDeserializer;
 
-	/**
-	 * @param Deserializer $statementDeserializer
-	 */
 	public function __construct( Deserializer $statementDeserializer ) {
 		$this->statementDeserializer = $statementDeserializer;
 	}
diff --git a/src/Deserializers/TermListDeserializer.php b/src/Deserializers/TermListDeserializer.php
@@ -22,9 +22,6 @@ class TermListDeserializer implements Deserializer {
 	 */
 	private $termDeserializer;
 
-	/**
-	 * @param Deserializer $termDeserializer
-	 */
 	public function __construct( Deserializer $termDeserializer ) {
 		$this->termDeserializer = $termDeserializer;
 	}
diff --git a/src/Serializers/PropertySerializer.php b/src/Serializers/PropertySerializer.php
@@ -33,11 +33,6 @@ class PropertySerializer implements DispatchableSerializer {
 	 */
 	private $statementListSerializer;
 
-	/**
-	 * @param Serializer $termListSerializer
-	 * @param Serializer $aliasGroupListSerializer
-	 * @param Serializer $statementListSerializer
-	 */
 	public function __construct(
 		Serializer $termListSerializer,
 		Serializer $aliasGroupListSerializer,
diff --git a/src/Serializers/ReferenceListSerializer.php b/src/Serializers/ReferenceListSerializer.php
@@ -21,9 +21,6 @@ class ReferenceListSerializer implements DispatchableSerializer {
 	 */
 	private $referenceSerializer;
 
-	/**
-	 * @param Serializer $referenceSerializer
-	 */
 	public function __construct( Serializer $referenceSerializer ) {
 		$this->referenceSerializer = $referenceSerializer;
 	}
diff --git a/src/Serializers/ReferenceSerializer.php b/src/Serializers/ReferenceSerializer.php
@@ -23,9 +23,6 @@ class ReferenceSerializer implements DispatchableSerializer {
 	 */
 	private $snaksSerializer;
 
-	/**
-	 * @param Serializer $snaksSerializer
-	 */
 	public function __construct( Serializer $snaksSerializer ) {
 		$this->snaksSerializer = $snaksSerializer;
 	}
diff --git a/src/Serializers/StatementSerializer.php b/src/Serializers/StatementSerializer.php
@@ -39,11 +39,6 @@ class StatementSerializer implements DispatchableSerializer {
 	 */
 	private $referencesSerializer;
 
-	/**
-	 * @param Serializer $mainSnakSerializer
-	 * @param Serializer $qualifierSnaksSerializer
-	 * @param Serializer $referencesSerializer
-	 */
 	public function __construct(
 		Serializer $mainSnakSerializer,
 		Serializer $qualifierSnaksSerializer,
diff --git a/src/Serializers/TypedSnakSerializer.php b/src/Serializers/TypedSnakSerializer.php
@@ -20,9 +20,6 @@ class TypedSnakSerializer implements Serializer {
 	 */
 	private $snakSerializer;
 
-	/**
-	 * @param Serializer $snakSerializer
-	 */
 	public function __construct( Serializer $snakSerializer ) {
 		$this->snakSerializer = $snakSerializer;
 	}
diff --git a/tests/integration/ReferencesSerializationRoundtripTest.php b/tests/integration/ReferencesSerializationRoundtripTest.php
@@ -56,10 +56,6 @@ public function referencesProvider() {
 		);
 	}
 
-	/**
-	 * @param ReferenceList $expected
-	 * @param ReferenceList $actual
-	 */
 	public function assertReferenceListEquals( ReferenceList $expected, ReferenceList $actual ) {
 		$this->assertTrue( $actual->equals( $expected ), 'The two ReferenceList are different' );
 	}
diff --git a/tests/unit/Deserializers/ReferenceListDeserializerTest.php b/tests/unit/Deserializers/ReferenceListDeserializerTest.php
@@ -79,10 +79,6 @@ public function deserializationProvider() {
 		);
 	}
 
-	/**
-	 * @param ReferenceList $expected
-	 * @param ReferenceList $actual
-	 */
 	public function assertReferenceListEquals( ReferenceList $expected, ReferenceList $actual ) {
 		$this->assertTrue( $actual->equals( $expected ), 'The two ReferenceList are different' );
 	}

Original file line number	Diff line number	Diff line change
`@@ -21,9 +21,6 @@ class EntityIdDeserializer implements Deserializer {`
`21`	`21`	`*/`
`22`	`22`	`private $entityIdParser;`
`23`	`23`
`24`		`- /**`
`25`		`- * @param EntityIdParser $entityIdParser`
`26`		`- */`
`27`	`24`	`public function __construct( EntityIdParser $entityIdParser ) {`
`28`	`25`	`$this->entityIdParser = $entityIdParser;`
`29`	`26`	`}`
Original file line number	Diff line number	Diff line change
`@@ -22,9 +22,6 @@ class ReferenceDeserializer implements DispatchableDeserializer {`
`22`	`22`	`*/`
`23`	`23`	`private $snaksDeserializer;`
`24`	`24`
`25`		`- /**`
`26`		`- * @param Deserializer $snaksDeserializer`
`27`		`- */`
`28`	`25`	`public function __construct( Deserializer $snaksDeserializer ) {`
`29`	`26`	`$this->snaksDeserializer = $snaksDeserializer;`
`30`	`27`	`}`
Original file line number	Diff line number	Diff line change
`@@ -20,9 +20,6 @@ class ReferenceListDeserializer implements Deserializer {`
`20`	`20`	`*/`
`21`	`21`	`private $referenceDeserializer;`
`22`	`22`
`23`		`- /**`
`24`		`- * @param Deserializer $referenceDeserializer`
`25`		`- */`
`26`	`23`	`public function __construct( Deserializer $referenceDeserializer ) {`
`27`	`24`	`$this->referenceDeserializer = $referenceDeserializer;`
`28`	`25`	`}`
Original file line number	Diff line number	Diff line change
`@@ -22,9 +22,6 @@ class SiteLinkDeserializer implements Deserializer {`
`22`	`22`	`*/`
`23`	`23`	`private $entityIdDeserializer;`
`24`	`24`
`25`		`- /**`
`26`		`- * @param Deserializer $entityIdDeserializer`
`27`		`- */`
`28`	`25`	`public function __construct( Deserializer $entityIdDeserializer ) {`
`29`	`26`	`$this->entityIdDeserializer = $entityIdDeserializer;`
`30`	`27`	`}`
Original file line number	Diff line number	Diff line change
`@@ -21,9 +21,6 @@ class SnakListDeserializer implements Deserializer {`
`21`	`21`	`*/`
`22`	`22`	`private $snakDeserializer;`
`23`	`23`
`24`		`- /**`
`25`		`- * @param Deserializer $snakDeserializer`
`26`		`- */`
`27`	`24`	`public function __construct( Deserializer $snakDeserializer ) {`
`28`	`25`	`$this->snakDeserializer = $snakDeserializer;`
`29`	`26`	`}`
Original file line number	Diff line number	Diff line change
`@@ -21,9 +21,6 @@ class StatementListDeserializer implements Deserializer {`
`21`	`21`	`*/`
`22`	`22`	`private $statementDeserializer;`
`23`	`23`
`24`		`- /**`
`25`		`- * @param Deserializer $statementDeserializer`
`26`		`- */`
`27`	`24`	`public function __construct( Deserializer $statementDeserializer ) {`
`28`	`25`	`$this->statementDeserializer = $statementDeserializer;`
`29`	`26`	`}`