PhpDoc: Add missing types & correct incorrect types

elcodi · Mar 16, 2015 · 22e8025 · 22e8025
1 parent 36f2d07
commit 22e8025
Show file tree

Hide file tree

Showing 10 changed files with 10 additions and 10 deletions.
diff --git a/src/Elcodi/Component/CartCoupon/EventListener/MinimumPriceCouponListener.php b/src/Elcodi/Component/CartCoupon/EventListener/MinimumPriceCouponListener.php
@@ -34,7 +34,7 @@ class MinimumPriceCouponListener
     protected $currencyConverter;
 
     /**
-     * @param $currencyConverter
+     * @param CurrencyConverter $currencyConverter
      */
     public function __construct($currencyConverter)
     {

diff --git a/src/Elcodi/Component/Comment/Controller/CommentController.php b/src/Elcodi/Component/Comment/Controller/CommentController.php
@@ -75,7 +75,7 @@ public function __construct(
      * @param string $context Context
      * @param string $source  Source
      *
-     * @return array Comments
+     * @return Response Comments
      */
     public function listCommentsAction($context, $source)
     {

diff --git a/src/Elcodi/Component/Configuration/Services/ConfigurationManager.php b/src/Elcodi/Component/Configuration/Services/ConfigurationManager.php
@@ -231,7 +231,7 @@ public function get($configurationIdentifier)
     /**
      * Deletes a parameter given the format "namespace.key"
      *
-     * @param $configurationIdentifier
+     * @param string $configurationIdentifier
      *
      * @return bool
      *

diff --git a/src/Elcodi/Component/Core/Generator/Interfaces/GeneratorInterface.php b/src/Elcodi/Component/Core/Generator/Interfaces/GeneratorInterface.php
@@ -31,7 +31,7 @@ interface GeneratorInterface
     /**
      * Generates a hash
      *
-     * @param string $length Length of generation
+     * @param integer $length Length of generation
      *
      * @return string Generation
      */

diff --git a/src/Elcodi/Component/Core/Generator/RandomGenerator.php b/src/Elcodi/Component/Core/Generator/RandomGenerator.php
@@ -27,7 +27,7 @@ class RandomGenerator implements GeneratorInterface
     /**
      * Generates a random string with entropy
      *
-     * @param string $length Length of generation
+     * @param integer $length Length of generation
      *
      * @return string Result of generation
      */

diff --git a/src/Elcodi/Component/Core/Generator/Sha1Generator.php b/src/Elcodi/Component/Core/Generator/Sha1Generator.php
@@ -46,7 +46,7 @@ public function __construct(GeneratorInterface $generator)
     /**
      * Generates a random string
      *
-     * @param string $length Length of generation
+     * @param integer $length Length of generation
      *
      * @return string Result of generation
      */

diff --git a/src/Elcodi/Component/Core/Generator/UniqIdGenerator.php b/src/Elcodi/Component/Core/Generator/UniqIdGenerator.php
@@ -29,7 +29,7 @@ class UniqIdGenerator implements GeneratorInterface
     /**
      * Generates a unique Id
      *
-     * @param string $length Length of generation
+     * @param integer $length Length of generation
      *
      * @return string Result of generation
      */

diff --git a/src/Elcodi/Component/Metric/Core/Entity/Entry.php b/src/Elcodi/Component/Metric/Core/Entity/Entry.php
@@ -144,7 +144,7 @@ public function getType()
     /**
      * Get CreatedAt
      *
-     * @return mixed CreatedAt
+     * @return DateTime|null CreatedAt
      */
     public function getCreatedAt()
     {

diff --git a/src/Elcodi/Component/Product/Repository/VariantRepository.php b/src/Elcodi/Component/Product/Repository/VariantRepository.php
@@ -33,7 +33,7 @@ class VariantRepository extends EntityRepository
      * returns the Variant that is associated with the options matching the IDs, if any
      *
      * @param ProductInterface $product            to compare Variants from
-     * @param                  $optionsSearchedIds array containing IDs of the options to match
+     * @param array            $optionsSearchedIds array containing IDs of the options to match
      *
      * @return VariantInterface|null Variant if found, or null if not
      */

diff --git a/src/Elcodi/Component/Rule/Repository/RuleRepository.php b/src/Elcodi/Component/Rule/Repository/RuleRepository.php
@@ -29,7 +29,7 @@ class RuleRepository extends EntityRepository
     /**
      * Return a rule by name
      *
-     * @param $name
+     * @param string $name
      *
      * @return null|RuleInterface
      */