PHPDoc fixing

jimmyoak · Sep 21, 2015 · 770c23b · 770c23b
1 parent 3a5161c
commit 770c23b
Show file tree

Hide file tree

Showing 6 changed files with 30 additions and 24 deletions.
diff --git a/src/Collection/Collection.php b/src/Collection/Collection.php
@@ -7,11 +7,6 @@ class Collection implements \ArrayAccess, \Countable, \IteratorAggregate
     /** @var array */
     protected $collection = [];
 
-    /**
-     * @param mixed $offset
-     *
-     * @return bool
-     */
     public function offsetExists($offset)
     {
         return isset($this->collection[$offset]);

diff --git a/src/Collection/TypedCollection.php b/src/Collection/TypedCollection.php
@@ -8,19 +8,32 @@
 
 class TypedCollection extends Collection
 {
-    /** @var string */
+    /**
+     * @var string
+     */
     private $objectType;
 
+    /**
+     * @param string $objectType
+     */
     public function __construct($objectType)
     {
-        $this->objectType = $objectType;
+        $this->setObjectType($objectType);
     }
 
+    /**
+     * @return string
+     */
     public function getObjectType()
     {
         return $this->objectType;
     }
 
+    /**
+     * @param string $objectType
+     *
+     * @return $this
+     */
     protected function setObjectType($objectType)
     {
         $this->objectType = $objectType;

diff --git a/src/DataType/Enum.php b/src/DataType/Enum.php
@@ -27,9 +27,6 @@ public static function getConstList()
         return $constants[static::class];
     }
 
-    /**
-     * @param $value
-     */
     private function guardAgainstValueNotInValidConstants($value)
     {
         if (!in_array($value, self::getConstList(), true)) {

diff --git a/src/Utility/FileUtils.php b/src/Utility/FileUtils.php
@@ -60,11 +60,6 @@ public function extensionIs($fileName, $extension)
         return preg_match('/\.' . $extensionPregQuoted . '$/i', $fileName) > 0;
     }
 
-    /**
-     * @param $path
-     *
-     * @return string
-     */
     private function stripPathLastDirectorySeparator($path)
     {
         $pathLength = strlen($path);

diff --git a/src/Utility/ObjectUtils.php b/src/Utility/ObjectUtils.php
@@ -87,11 +87,6 @@ private function toDeepArray($object)
         return $array;
     }
 
-    /**
-     * @param $object
-     *
-     * @return array
-     */
     private function toShallowArray($object)
     {
         $array = [];

diff --git a/src/Utility/Utils.php b/src/Utility/Utils.php
@@ -4,13 +4,24 @@
 
 class Utils extends UtilsBase
 {
-    /** @var ArrayUtils */
+    /**
+     * @var ArrayUtils
+     */
     public $array;
-    /** @var FileUtils */
+
+    /**
+     * @var FileUtils
+     */
     public $file;
-    /** @var ObjectUtils */
+
+    /**
+     * @var ObjectUtils
+     */
     public $object;
-    /** @var StringUtils */
+
+    /**
+     * @var StringUtils
+     */
     public $string;
 
     protected function __construct()