Merge pull request #7048 from malukenho/enhancement/remove-redundant-…

…docs Remove redundant php-docs
doctrine · Mar 2, 2018 · f4ef0a1 · f4ef0a1
2 parents bbc1ed9 + a31ce59
commit f4ef0a1
Show file tree

Hide file tree

Showing 45 changed files with 8 additions and 136 deletions.
diff --git a/lib/Doctrine/ORM/Cache/Lock.php b/lib/Doctrine/ORM/Cache/Lock.php
@@ -7,9 +7,6 @@
 use function time;
 use function uniqid;
 
-/**
- * Cache Lock
- */
 class Lock
 {
     /**
@@ -22,11 +19,7 @@ class Lock
      */
     public $time;
 
-    /**
-     * @param string $value
-     * @param int    $time
-     */
-    public function __construct($value, $time = null)
+    public function __construct(string $value, int $time = null)
     {
         $this->value = $value;
         $this->time  = $time ?: time();

diff --git a/lib/Doctrine/ORM/Cache/Logging/CacheLoggerChain.php b/lib/Doctrine/ORM/Cache/Logging/CacheLoggerChain.php
@@ -8,9 +8,6 @@
 use Doctrine\ORM\Cache\EntityCacheKey;
 use Doctrine\ORM\Cache\QueryCacheKey;
 
-/**
- * Cache logger chain
- */
 class CacheLoggerChain implements CacheLogger
 {
     /**

diff --git a/lib/Doctrine/ORM/Cache/Logging/StatisticsCacheLogger.php b/lib/Doctrine/ORM/Cache/Logging/StatisticsCacheLogger.php
@@ -11,7 +11,6 @@
 
 /**
  * Provide basic second level cache statistics.
- *
  */
 class StatisticsCacheLogger implements CacheLogger
 {

diff --git a/lib/Doctrine/ORM/Cache/QueryCacheKey.php b/lib/Doctrine/ORM/Cache/QueryCacheKey.php
@@ -32,18 +32,13 @@ class QueryCacheKey extends CacheKey
      */
     public $timestampKey;
 
-    /**
-     * @param string $hash      Result cache id
-     * @param int    $lifetime  Query lifetime
-     * @param int    $cacheMode Query cache mode
-     */
     public function __construct(
-        $hash,
-        $lifetime = 0,
-        $cacheMode = Cache::MODE_NORMAL,
+        string $cacheId,
+        int $lifetime = 0,
+        int $cacheMode = Cache::MODE_NORMAL,
         ?TimestampCacheKey $timestampKey = null
     ) {
-        $this->hash         = $hash;
+        $this->hash         = $cacheId;
         $this->lifetime     = $lifetime;
         $this->cacheMode    = $cacheMode;
         $this->timestampKey = $timestampKey;

diff --git a/lib/Doctrine/ORM/Cache/Region/DefaultMultiGetRegion.php b/lib/Doctrine/ORM/Cache/Region/DefaultMultiGetRegion.php
@@ -11,7 +11,6 @@
 
 /**
  * A cache region that enables the retrieval of multiple elements with one call
- *
  */
 class DefaultMultiGetRegion extends DefaultRegion
 {

diff --git a/lib/Doctrine/ORM/Mapping/CacheMetadata.php b/lib/Doctrine/ORM/Mapping/CacheMetadata.php
@@ -4,10 +4,6 @@
 
 namespace Doctrine\ORM\Mapping;
 
-/**
- * Class CacheMetadata
- *
- */
 class CacheMetadata
 {
     /** @var string */

diff --git a/lib/Doctrine/ORM/Mapping/ClassMetadataBuildingContext.php b/lib/Doctrine/ORM/Mapping/ClassMetadataBuildingContext.php
@@ -26,9 +26,6 @@
 use Doctrine\ORM\Mapping\Factory\NamingStrategy;
 use Doctrine\ORM\Reflection\ReflectionService;
 
-/**
- * Class ClassMetadataBuildingContext
- */
 class ClassMetadataBuildingContext
 {
     /** @var AbstractClassMetadataFactory */

diff --git a/lib/Doctrine/ORM/Mapping/ColumnMetadata.php b/lib/Doctrine/ORM/Mapping/ColumnMetadata.php
@@ -6,9 +6,6 @@
 
 use Doctrine\DBAL\Types\Type;
 
-/**
- * Class ColumnMetadata
- */
 abstract class ColumnMetadata
 {
     /**

diff --git a/lib/Doctrine/ORM/Mapping/DiscriminatorColumnMetadata.php b/lib/Doctrine/ORM/Mapping/DiscriminatorColumnMetadata.php
@@ -4,9 +4,6 @@
 
 namespace Doctrine\ORM\Mapping;
 
-/**
- * Class DiscriminatorColumnMetadata
- */
 final class DiscriminatorColumnMetadata extends LocalColumnMetadata
 {
 }
diff --git a/lib/Doctrine/ORM/Mapping/Driver/Annotation/Binder/MappedSuperClassMetadataBinder.php b/lib/Doctrine/ORM/Mapping/Driver/Annotation/Binder/MappedSuperClassMetadataBinder.php
@@ -7,9 +7,6 @@
 use Doctrine\ORM\Annotation;
 use Doctrine\ORM\Mapping;
 
-/**
- * Class MappedSuperClassMetadataBinder
- */
 class MappedSuperClassMetadataBinder
 {
     /**

diff --git a/lib/Doctrine/ORM/Mapping/EmbeddedClassMetadata.php b/lib/Doctrine/ORM/Mapping/EmbeddedClassMetadata.php
@@ -7,8 +7,6 @@
 use Doctrine\ORM\Reflection\ReflectionService;
 
 /**
- * Class EmbeddedClassMetadata
- *
  * @property MappedSuperClassMetadata $parent
  */
 class EmbeddedClassMetadata extends ComponentMetadata implements Property

diff --git a/lib/Doctrine/ORM/Mapping/EntityClassMetadata.php b/lib/Doctrine/ORM/Mapping/EntityClassMetadata.php
@@ -6,10 +6,6 @@
 
 use function sprintf;
 
-/**
- * Class EntityClassMetadata
- *
- */
 abstract class EntityClassMetadata extends ComponentMetadata
 {
     /** @var string The name of the Entity */

diff --git a/lib/Doctrine/ORM/Mapping/FetchMode.php b/lib/Doctrine/ORM/Mapping/FetchMode.php
@@ -4,9 +4,6 @@
 
 namespace Doctrine\ORM\Mapping;
 
-/**
- * Class FetchMode
- */
 final class FetchMode
 {
     /**

diff --git a/lib/Doctrine/ORM/Mapping/FieldMetadata.php b/lib/Doctrine/ORM/Mapping/FieldMetadata.php
@@ -7,9 +7,6 @@
 use Doctrine\DBAL\Types\Type;
 use Doctrine\ORM\Reflection\ReflectionService;
 
-/**
- * Class FieldMetadata
- */
 class FieldMetadata extends LocalColumnMetadata implements Property
 {
     /** @var ComponentMetadata */
@@ -34,9 +31,6 @@ class FieldMetadata extends LocalColumnMetadata implements Property
         $this->name = $name;
     }*/
 
-    /**
-     * Constructor
-     */
     public function __construct(string $name)
     {
         $this->name = $name;

diff --git a/lib/Doctrine/ORM/Mapping/GeneratorType.php b/lib/Doctrine/ORM/Mapping/GeneratorType.php
@@ -4,9 +4,6 @@
 
 namespace Doctrine\ORM\Mapping;
 
-/**
- * Class GeneratorType
- */
 final class GeneratorType
 {
     /**

diff --git a/lib/Doctrine/ORM/Mapping/InheritanceType.php b/lib/Doctrine/ORM/Mapping/InheritanceType.php
@@ -4,9 +4,6 @@
 
 namespace Doctrine\ORM\Mapping;
 
-/**
- * Class InheritanceType
- */
 final class InheritanceType
 {
     /**

diff --git a/lib/Doctrine/ORM/Mapping/JoinColumnMetadata.php b/lib/Doctrine/ORM/Mapping/JoinColumnMetadata.php
@@ -6,9 +6,6 @@
 
 use function strtoupper;
 
-/**
- * Class JoinColumnMetadata
- */
 class JoinColumnMetadata extends ColumnMetadata
 {
     /** @var string|null */

diff --git a/lib/Doctrine/ORM/Mapping/JoinTableMetadata.php b/lib/Doctrine/ORM/Mapping/JoinTableMetadata.php
@@ -4,9 +4,6 @@
 
 namespace Doctrine\ORM\Mapping;
 
-/**
- * Class JoinTableMetadata
- */
 final class JoinTableMetadata extends TableMetadata
 {
     /** @var JoinColumnMetadata[] */

diff --git a/lib/Doctrine/ORM/Mapping/LocalColumnMetadata.php b/lib/Doctrine/ORM/Mapping/LocalColumnMetadata.php
@@ -4,9 +4,6 @@
 
 namespace Doctrine\ORM\Mapping;
 
-/**
- * Class LocalColumnMetadata
- */
 abstract class LocalColumnMetadata extends ColumnMetadata
 {
     /**

diff --git a/lib/Doctrine/ORM/Mapping/ManyToManyAssociationMetadata.php b/lib/Doctrine/ORM/Mapping/ManyToManyAssociationMetadata.php
@@ -4,9 +4,6 @@
 
 namespace Doctrine\ORM\Mapping;
 
-/**
- * Class ManyToManyAssociationMetadata
- */
 class ManyToManyAssociationMetadata extends ToManyAssociationMetadata
 {
     /** @var JoinTableMetadata|null */

diff --git a/lib/Doctrine/ORM/Mapping/ManyToOneAssociationMetadata.php b/lib/Doctrine/ORM/Mapping/ManyToOneAssociationMetadata.php
@@ -4,9 +4,6 @@
 
 namespace Doctrine\ORM\Mapping;
 
-/**
- * Class ManyToOneAssociationMetadata
- */
 class ManyToOneAssociationMetadata extends ToOneAssociationMetadata
 {
 }
diff --git a/lib/Doctrine/ORM/Mapping/MappedSuperClassMetadata.php b/lib/Doctrine/ORM/Mapping/MappedSuperClassMetadata.php
@@ -4,9 +4,6 @@
 
 namespace Doctrine\ORM\Mapping;
 
-/**
- * Class MappedSuperClassMetadata
- */
 class MappedSuperClassMetadata extends ComponentMetadata
 {
     /**

diff --git a/lib/Doctrine/ORM/Mapping/OneToManyAssociationMetadata.php b/lib/Doctrine/ORM/Mapping/OneToManyAssociationMetadata.php
@@ -4,9 +4,6 @@
 
 namespace Doctrine\ORM\Mapping;
 
-/**
- * Class OneToManyAssociationMetadata
- */
 class OneToManyAssociationMetadata extends ToManyAssociationMetadata
 {
 }
diff --git a/lib/Doctrine/ORM/Mapping/OneToOneAssociationMetadata.php b/lib/Doctrine/ORM/Mapping/OneToOneAssociationMetadata.php
@@ -4,9 +4,6 @@
 
 namespace Doctrine\ORM\Mapping;
 
-/**
- * Class OneToOneAssociationMetadata
- */
 class OneToOneAssociationMetadata extends ToOneAssociationMetadata
 {
 }
diff --git a/lib/Doctrine/ORM/Mapping/RootClassMetadata.php b/lib/Doctrine/ORM/Mapping/RootClassMetadata.php
@@ -5,8 +5,6 @@
 namespace Doctrine\ORM\Mapping;
 
 /**
- * Class RootClassMetadata
- *
  * @property MappedSuperClassMetadata $parent
  */
 class RootClassMetadata extends EntityClassMetadata

diff --git a/lib/Doctrine/ORM/Mapping/SubClassMetadata.php b/lib/Doctrine/ORM/Mapping/SubClassMetadata.php
@@ -5,8 +5,6 @@
 namespace Doctrine\ORM\Mapping;
 
 /**
- * Class SubClassMetadata
- *
  * @property EntityClassMetadata $parent
  */
 class SubClassMetadata extends EntityClassMetadata

diff --git a/lib/Doctrine/ORM/Mapping/TableMetadata.php b/lib/Doctrine/ORM/Mapping/TableMetadata.php
@@ -8,8 +8,6 @@
 use function sprintf;
 
 /**
- * Class TableMetadata
- *
  * @todo guilhermeblanco Add constructor requiring tableName and optional schemaName
  */
 class TableMetadata

diff --git a/lib/Doctrine/ORM/Mapping/TableOwner.php b/lib/Doctrine/ORM/Mapping/TableOwner.php
@@ -4,9 +4,6 @@
 
 namespace Doctrine\ORM\Mapping;
 
-/**
- * Interface TableOwner
- */
 interface TableOwner
 {
     /**

diff --git a/lib/Doctrine/ORM/Mapping/ToManyAssociationMetadata.php b/lib/Doctrine/ORM/Mapping/ToManyAssociationMetadata.php
@@ -9,9 +9,6 @@
 use Doctrine\ORM\EntityManagerInterface;
 use Doctrine\ORM\PersistentCollection;
 
-/**
- * Class ToManyAssociationMetadata
- */
 class ToManyAssociationMetadata extends AssociationMetadata
 {
     /** @var string[] */

diff --git a/lib/Doctrine/ORM/Mapping/ToOneAssociationMetadata.php b/lib/Doctrine/ORM/Mapping/ToOneAssociationMetadata.php
@@ -4,9 +4,6 @@
 
 namespace Doctrine\ORM\Mapping;
 
-/**
- * Class ToOneAssociationMetadata
- */
 class ToOneAssociationMetadata extends AssociationMetadata
 {
     /**

diff --git a/lib/Doctrine/ORM/Mapping/TransientMetadata.php b/lib/Doctrine/ORM/Mapping/TransientMetadata.php
@@ -6,9 +6,6 @@
 
 use Doctrine\ORM\Reflection\ReflectionService;
 
-/**
- * Class TransientMetadata
- */
 class TransientMetadata implements Property
 {
     /** @var ClassMetadata */

diff --git a/lib/Doctrine/ORM/Mapping/ValueGeneratorMetadata.php b/lib/Doctrine/ORM/Mapping/ValueGeneratorMetadata.php
@@ -4,9 +4,6 @@
 
 namespace Doctrine\ORM\Mapping;
 
-/**
- * Class ValueGeneratorMetadata
- */
 class ValueGeneratorMetadata
 {
     /** @var string */

diff --git a/lib/Doctrine/ORM/Mapping/VersionFieldMetadata.php b/lib/Doctrine/ORM/Mapping/VersionFieldMetadata.php
@@ -4,9 +4,6 @@
 
 namespace Doctrine\ORM\Mapping;
 
-/**
- * Class VersionFieldMetadata
- */
 final class VersionFieldMetadata extends FieldMetadata
 {
 }
diff --git a/lib/Doctrine/ORM/Persisters/Collection/AbstractCollectionPersister.php b/lib/Doctrine/ORM/Persisters/Collection/AbstractCollectionPersister.php
@@ -11,7 +11,6 @@
 
 /**
  * Base class for all collection persisters.
- *
  */
 abstract class AbstractCollectionPersister implements CollectionPersister
 {
@@ -39,7 +38,6 @@ abstract class AbstractCollectionPersister implements CollectionPersister
 
     /**
      * Initializes a new instance of a class derived from AbstractCollectionPersister.
-     *
      */
     public function __construct(EntityManagerInterface $em)
     {

diff --git a/lib/Doctrine/ORM/Persisters/Collection/CollectionPersister.php b/lib/Doctrine/ORM/Persisters/Collection/CollectionPersister.php
@@ -8,7 +8,6 @@
 use Doctrine\ORM\PersistentCollection;
 
 /**
- * Collection persister interface
  * Define the behavior that should be implemented by all collection persisters.
  */
 interface CollectionPersister

diff --git a/lib/Doctrine/ORM/PessimisticLockException.php b/lib/Doctrine/ORM/PessimisticLockException.php
@@ -4,9 +4,6 @@
 
 namespace Doctrine\ORM;
 
-/**
- * Pessimistic Lock Exception
- */
 class PessimisticLockException extends ORMException
 {
     /**